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",
518 description: "Instance-related settings",
523 description: "Name of the instance",
530 label: "Admin Email Address",
532 description: "Email used to reach an Administrator/Moderator of the instance",
539 label: "Sender Email Address",
541 description: "Envelope FROM address for mail sent via Pleroma",
550 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
558 description: "Posts character limit (CW/Subject included in the counter)",
566 description: "Character limit of the instance chat messages",
574 description: "Hard character limit beyond which remote posts will be dropped",
582 description: "File size limit of uploads (except for avatar, background, banner)",
588 key: :avatar_upload_limit,
590 description: "File size limit of user's profile avatars",
596 key: :background_upload_limit,
598 description: "File size limit of user's profile backgrounds",
604 key: :banner_upload_limit,
606 description: "File size limit of user's profile banners",
614 description: "A map with poll limits for local polls",
618 max_option_chars: 200,
620 max_expiration: 31_536_000
627 description: "Maximum number of options",
631 key: :max_option_chars,
633 description: "Maximum number of characters per option",
637 key: :min_expiration,
639 description: "Minimum expiration time (in seconds)",
643 key: :max_expiration,
645 description: "Maximum expiration time (in seconds)",
651 key: :registrations_open,
654 "Enable registrations for anyone. Invitations require this setting to be disabled."
657 key: :invites_enabled,
660 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
663 key: :account_activation_required,
665 description: "Require users to confirm their emails before signing in"
670 description: "Enable federation with other instances"
673 key: :federation_incoming_replies_max_depth,
674 label: "Fed. incoming replies max depth",
677 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
678 " 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.",
684 key: :federation_reachability_timeout_days,
685 label: "Fed. reachability timeout days",
688 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
696 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
702 "Makes the client API in authentificated mode-only except for user-profiles." <>
703 " Useful for disabling the Local Timeline and The Whole Known Network."
706 key: :quarantined_instances,
707 type: {:list, :string},
709 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
716 key: :managed_config,
719 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
724 description: "Instance static directory",
730 key: :allowed_post_formats,
731 type: {:list, :string},
732 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
741 key: :extended_nickname_format,
744 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
745 " This will break federation with older software for theses nicknames."
748 key: :cleanup_attachments,
751 Enable to remove associated attachments when status is removed.
752 This will not affect duplicates and attachments without status.
753 Enabling this will increase load to database when deleting statuses on larger instances.
757 key: :max_pinned_statuses,
759 description: "The maximum number of pinned statuses. 0 will disable the feature.",
767 key: :autofollowed_nicknames,
768 type: {:list, :string},
770 "Set to nicknames of (local) users that every new user should automatically follow",
779 key: :attachment_links,
781 description: "Enable to automatically add attachment link text to statuses"
784 key: :welcome_message,
787 "A message that will be sent to a newly registered users as a direct message",
789 "Hi, @username! Welcome on board!"
793 key: :welcome_user_nickname,
795 description: "The nickname of the local user that sends the welcome message",
801 key: :max_report_comment_size,
803 description: "The maximum size of the report comment. Default: 1000.",
809 key: :safe_dm_mentions,
810 label: "Safe DM mentions",
813 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
814 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
820 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
823 key: :remote_post_retention_days,
826 "The default amount of days to retain remote posts when pruning the database",
832 key: :user_bio_length,
834 description: "A user bio maximum length. Default: 5000.",
840 key: :user_name_length,
842 description: "A user name maximum length. Default: 100.",
848 key: :skip_thread_containment,
850 description: "Skip filtering out broken threads. Default: enabled."
853 key: :limit_to_local_content,
854 type: {:dropdown, :atom},
856 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
864 key: :max_account_fields,
866 description: "The maximum number of custom fields in the user profile. Default: 10.",
872 key: :max_remote_account_fields,
875 "The maximum number of custom fields in the remote user profile. Default: 20.",
881 key: :account_field_name_length,
883 description: "An account field name maximum length. Default: 512.",
889 key: :account_field_value_length,
891 description: "An account field value maximum length. Default: 2048.",
897 key: :external_user_synchronization,
899 description: "Enabling following/followers counters synchronization for external users"
902 key: :multi_factor_authentication,
904 description: "Multi-factor authentication settings",
907 totp: [digits: 6, period: 30],
908 backup_codes: [number: 5, length: 16]
914 label: "TOTP settings",
916 description: "TOTP settings",
917 suggestions: [digits: 6, period: 30],
924 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
931 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
938 description: "MFA backup codes settings",
939 suggestions: [number: 5, length: 16],
945 description: "Number of backup codes to generate."
952 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
959 key: :instance_thumbnail,
962 "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.",
963 suggestions: ["/instance/thumbnail.jpeg"]
970 description: "Logger-related settings",
974 type: [:atom, :tuple, :module],
976 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
977 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
985 label: "ExSyslogger",
986 description: "ExSyslogger-related settings",
990 type: {:dropdown, :atom},
991 description: "Log level",
992 suggestions: [:debug, :info, :warn, :error]
998 "A string that's prepended to every message, and is typically set to the app name",
999 suggestions: ["pleroma"]
1004 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1005 suggestions: ["$metadata[$level] $message"]
1009 type: {:list, :atom},
1010 suggestions: [:request_id]
1018 label: "Console Logger",
1019 description: "Console logger settings",
1023 type: {:dropdown, :atom},
1024 description: "Log level",
1025 suggestions: [:debug, :info, :warn, :error]
1030 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1031 suggestions: ["$metadata[$level] $message"]
1035 type: {:list, :atom},
1036 suggestions: [:request_id]
1043 label: "Quack Logger",
1044 description: "Quack-related settings",
1048 type: {:dropdown, :atom},
1049 description: "Log level",
1050 suggestions: [:debug, :info, :warn, :error]
1054 type: {:list, :atom},
1055 description: "Configure which metadata you want to report on",
1073 description: "Configure the Slack incoming webhook",
1074 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1080 key: :frontend_configurations,
1083 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1084 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1085 "add your own configuration your settings all fields must be complete.",
1089 label: "Pleroma FE",
1091 description: "Settings for Pleroma FE",
1094 alwaysShowSubjectInput: true,
1095 background: "/static/aurora_borealis.jpg",
1096 collapseMessageWithSubject: false,
1099 hideFilteredStatuses: false,
1100 hideMutedPosts: false,
1101 hidePostStats: false,
1102 hideSitename: false,
1103 hideUserStats: false,
1104 loginMethod: "password",
1105 logo: "/static/logo.png",
1108 minimalScopesMode: false,
1109 noAttachmentLinks: false,
1110 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1111 postContentType: "text/plain",
1112 redirectRootLogin: "/main/friends",
1113 redirectRootNoLogin: "/main/all",
1115 sidebarRight: false,
1116 showFeaturesPanel: true,
1117 showInstanceSpecificPanel: false,
1118 subjectLineBehavior: "email",
1119 theme: "pleroma-dark",
1120 webPushNotifications: false
1125 key: :alwaysShowSubjectInput,
1126 label: "Always show subject input",
1128 description: "When disabled, auto-hide the subject field if it's empty"
1134 "URL of the background, unless viewing a user profile with a background that is set",
1135 suggestions: ["/images/city.jpg"]
1138 key: :collapseMessageWithSubject,
1139 label: "Collapse message with subject",
1142 "When a message has a subject (aka Content Warning), collapse it by default"
1146 label: "PleromaFE Chat",
1148 description: "Disables PleromaFE Chat component"
1154 description: "Enables green text on lines prefixed with the > character"
1157 key: :hideFilteredStatuses,
1158 label: "Hide Filtered Statuses",
1160 description: "Hides filtered statuses from timelines"
1163 key: :hideMutedPosts,
1164 label: "Hide Muted Posts",
1166 description: "Hides muted statuses from timelines"
1169 key: :hidePostStats,
1170 label: "Hide post stats",
1172 description: "Hide notices statistics (repeats, favorites, ...)"
1176 label: "Hide Sitename",
1178 description: "Hides instance name from PleromaFE banner"
1181 key: :hideUserStats,
1182 label: "Hide user stats",
1185 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1190 description: "URL of the logo, defaults to Pleroma's logo",
1191 suggestions: ["/static/logo.png"]
1195 label: "Logo margin",
1198 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1199 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1200 suggestions: [".1em"]
1207 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1208 "If you want a colorful logo you must disable logoMask."
1211 key: :minimalScopesMode,
1212 label: "Minimal scopes mode",
1215 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1216 "Also prevents replying to a DM with a public post from PleromaFE."
1219 key: :nsfwCensorImage,
1220 label: "NSFW Censor Image",
1223 "URL of the image to use for hiding NSFW media attachments in the timeline",
1224 suggestions: ["/static/img/nsfw.74818f9.png"]
1227 key: :postContentType,
1228 label: "Post Content Type",
1229 type: {:dropdown, :atom},
1230 description: "Default post formatting option",
1231 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1234 key: :redirectRootNoLogin,
1235 label: "Redirect root no login",
1238 "Relative URL which indicates where to redirect when a user isn't logged in",
1239 suggestions: ["/main/all"]
1242 key: :redirectRootLogin,
1243 label: "Redirect root login",
1246 "Relative URL which indicates where to redirect when a user is logged in",
1247 suggestions: ["/main/friends"]
1251 label: "Scope copy",
1253 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1257 label: "Sidebar on Right",
1259 description: "Change alignment of sidebar and panels to the right"
1262 key: :showFeaturesPanel,
1263 label: "Show instance features panel",
1266 "Enables panel displaying functionality of the instance on the About page"
1269 key: :showInstanceSpecificPanel,
1270 label: "Show instance specific panel",
1272 description: "Whether to show the instance's custom panel"
1275 key: :subjectLineBehavior,
1276 label: "Subject line behavior",
1278 description: "Allows changing the default behaviour of subject lines in replies.
1279 `email`: copy and preprend re:, as in email,
1280 `masto`: copy verbatim, as in Mastodon,
1281 `noop`: don't copy the subject.",
1282 suggestions: ["email", "masto", "noop"]
1287 description: "Which theme to use. Available themes are defined in styles.json",
1288 suggestions: ["pleroma-dark"]
1296 description: "Settings for Masto FE",
1299 showInstanceSpecificPanel: true
1304 key: :showInstanceSpecificPanel,
1305 label: "Show instance specific panel",
1307 description: "Whenether to show the instance's specific panel"
1318 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1322 type: {:keyword, :map},
1324 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1327 url: "/images/pleroma-fox-tan-smol.png",
1328 mime_type: "image/png"
1330 pleroma_fox_tan_shy: %{
1331 url: "/images/pleroma-fox-tan-shy.png",
1332 mime_type: "image/png"
1337 key: :default_mascot,
1340 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1346 key: :default_user_avatar,
1348 description: "URL of the default user avatar",
1349 suggestions: ["/images/avi.png"]
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"]
1398 description: "General MRF settings",
1402 type: [:module, {:list, :module}],
1404 "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.",
1406 Generator.list_modules_in_dir(
1407 "lib/pleroma/web/activity_pub/mrf",
1408 "Elixir.Pleroma.Web.ActivityPub.MRF."
1413 label: "MRF transparency",
1416 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1419 key: :transparency_exclusions,
1420 label: "MRF transparency exclusions",
1421 type: {:list, :string},
1423 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1434 label: "MRF Simple",
1436 description: "Simple ingress policies",
1439 key: :media_removal,
1440 type: {:list, :string},
1441 description: "List of instances to strip media attachments from",
1442 suggestions: ["example.com", "*.example.com"]
1446 label: "Media NSFW",
1447 type: {:list, :string},
1448 description: "List of instances to tag all media as NSFW (sensitive) from",
1449 suggestions: ["example.com", "*.example.com"]
1452 key: :federated_timeline_removal,
1453 type: {:list, :string},
1455 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1456 suggestions: ["example.com", "*.example.com"]
1460 type: {:list, :string},
1461 description: "List of instances to reject activities from (except deletes)",
1462 suggestions: ["example.com", "*.example.com"]
1466 type: {:list, :string},
1467 description: "List of instances to only accept activities from (except deletes)",
1468 suggestions: ["example.com", "*.example.com"]
1471 key: :report_removal,
1472 type: {:list, :string},
1473 description: "List of instances to reject reports from",
1474 suggestions: ["example.com", "*.example.com"]
1477 key: :avatar_removal,
1478 type: {:list, :string},
1479 description: "List of instances to strip avatars from",
1480 suggestions: ["example.com", "*.example.com"]
1483 key: :banner_removal,
1484 type: {:list, :string},
1485 description: "List of instances to strip banners from",
1486 suggestions: ["example.com", "*.example.com"]
1489 key: :reject_deletes,
1490 type: {:list, :string},
1491 description: "List of instances to reject deletions from",
1492 suggestions: ["example.com", "*.example.com"]
1498 key: :mrf_activity_expiration,
1500 label: "MRF Activity Expiration Policy",
1502 description: "Adds automatic expiration to all local activities",
1507 description: "Default global expiration time for all local activities (in days)",
1508 suggestions: [90, 365]
1516 label: "MRF Subchain",
1519 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1520 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1525 description: "Matches a series of regular expressions against the actor field",
1528 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1536 key: :mrf_rejectnonpublic,
1539 "RejectNonPublic drops posts with non-public visibility settings.",
1540 label: "MRF Reject Non Public",
1544 key: :allow_followersonly,
1545 label: "Allow followers-only",
1547 description: "Whether to allow followers-only posts"
1552 description: "Whether to allow direct messages"
1558 key: :mrf_hellthread,
1560 label: "MRF Hellthread",
1562 description: "Block messages with excessive user mentions",
1565 key: :delist_threshold,
1568 "Number of mentioned users after which the message gets removed from timelines and" <>
1569 "disables notifications. Set to 0 to disable.",
1573 key: :reject_threshold,
1576 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1585 label: "MRF Keyword",
1587 description: "Reject or Word-Replace messages with a keyword or regex",
1591 type: [:string, :regex],
1593 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1594 suggestions: ["foo", ~r/foo/iu]
1597 key: :federated_timeline_removal,
1598 type: [:string, :regex],
1600 "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.",
1601 suggestions: ["foo", ~r/foo/iu]
1605 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1607 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1608 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1616 label: "MRF Mention",
1618 description: "Block messages which mention a specific user",
1622 type: {:list, :string},
1623 description: "A list of actors for which any post mentioning them will be dropped",
1624 suggestions: ["actor1", "actor2"]
1630 key: :mrf_vocabulary,
1632 label: "MRF Vocabulary",
1634 description: "Filter messages which belong to certain activity vocabularies",
1638 type: {:list, :string},
1640 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1641 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1645 type: {:list, :string},
1647 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1648 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1654 # key: :mrf_user_allowlist,
1657 # "The keys in this section are the domain names that the policy should apply to." <>
1658 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1660 # %{"example.org" => ["https://example.org/users/admin"]}
1668 description: "Media proxy",
1673 description: "Enables proxying of remote media to the instance's proxy"
1680 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1681 suggestions: ["https://example.com"]
1689 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1695 description: "Enables invalidate media cache"
1700 description: "Module which will be used to cache purge.",
1702 Pleroma.Web.MediaProxy.Invalidation.Script,
1703 Pleroma.Web.MediaProxy.Invalidation.Http
1710 label: "Proxy Options",
1712 description: "Options for Pleroma.ReverseProxy",
1714 redirect_on_failure: false,
1715 max_body_length: 25 * 1_048_576,
1717 follow_redirect: true,
1723 key: :redirect_on_failure,
1726 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1727 "Any error during body processing will not be redirected as the response is chunked."
1730 key: :max_body_length,
1733 "Limits the content length to be approximately the " <>
1734 "specified length. It is validated with the `content-length` header and also verified when proxying."
1740 description: "HTTP options",
1745 description: "Adapter specific options",
1750 label: "SSL Options",
1751 description: "SSL options for HTTP adapter",
1755 type: {:list, :atom},
1756 description: "List of TLS version to use",
1757 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1766 type: [:string, :tuple],
1767 description: "Proxy URL",
1768 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1776 type: {:list, :string},
1777 description: "List of domains to bypass the mediaproxy",
1778 suggestions: ["example.com"]
1784 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1786 description: "HTTP invalidate settings",
1791 description: "HTTP method of request. Default: :purge"
1795 type: {:list, :tuple},
1796 description: "HTTP headers of request.",
1797 suggestions: [{"x-refresh", 1}]
1802 description: "Request options.",
1803 suggestions: [params: %{ts: "xxx"}]
1809 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1811 description: "Script invalidate settings",
1816 description: "Path to shell script. Which will run purge cache.",
1817 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1825 description: "Gopher settings",
1830 description: "Enables the gopher interface"
1836 description: "IP address to bind to",
1837 suggestions: [{0, 0, 0, 0}]
1842 description: "Port to bind to",
1848 description: "Port advertised in URLs (optional, defaults to port)",
1856 label: "ActivityPub",
1858 description: "ActivityPub-related settings",
1861 key: :unfollow_blocked,
1863 description: "Whether blocks result in people getting unfollowed"
1866 key: :outgoing_blocks,
1868 description: "Whether to federate blocks to other instances"
1871 key: :sign_object_fetches,
1873 description: "Sign object fetches with HTTP signatures"
1876 key: :note_replies_output_limit,
1879 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1882 key: :follow_handshake_timeout,
1884 description: "Following handshake timeout",
1891 key: :http_security,
1892 label: "HTTP security",
1894 description: "HTTP security settings",
1899 description: "Whether the managed content security policy is enabled"
1905 description: "Whether to additionally send a Strict-Transport-Security header"
1909 label: "STS max age",
1911 description: "The maximum age for the Strict-Transport-Security header if sent",
1912 suggestions: [31_536_000]
1916 label: "CT max age",
1918 description: "The maximum age for the Expect-CT header if sent",
1919 suggestions: [2_592_000]
1922 key: :referrer_policy,
1924 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1925 suggestions: ["same-origin", "no-referrer"]
1929 label: "Report URI",
1931 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1932 suggestions: ["https://example.com/report-uri"]
1937 group: :web_push_encryption,
1938 key: :vapid_details,
1939 label: "Vapid Details",
1942 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1948 "A mailto link for the administrative contact." <>
1949 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1950 suggestions: ["mailto:moderators@pleroma.com"]
1955 description: "VAPID public key",
1956 suggestions: ["Public key"]
1961 description: "VAPID private key",
1962 suggestions: ["Private key"]
1968 key: Pleroma.Captcha,
1970 description: "Captcha-related settings",
1975 description: "Whether the captcha should be shown on registration"
1980 description: "The method/service to use for captcha",
1981 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1984 key: :seconds_valid,
1986 description: "The time in seconds for which the captcha is valid",
1993 key: Pleroma.Captcha.Kocaptcha,
1996 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1997 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2002 description: "The kocaptcha endpoint to use",
2003 suggestions: ["https://captcha.kotobank.ch"]
2009 label: "Pleroma Admin Token",
2012 "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",
2017 description: "Admin token",
2018 suggestions: ["We recommend a secure random string or UUID"]
2027 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2029 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2030 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2031 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2032 (see https://github.com/sorentwo/oban/issues/52).
2037 type: {:dropdown, :atom},
2038 description: "Logs verbose mode",
2039 suggestions: [false, :error, :warn, :info, :debug]
2043 type: [:atom, :tuple],
2045 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
2046 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
2050 type: {:keyword, :integer},
2052 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2054 activity_expiration: 10,
2055 attachments_cleanup: 5,
2057 federator_incoming: 50,
2058 federator_outgoing: 50,
2060 scheduled_activities: 10,
2066 key: :activity_expiration,
2068 description: "Activity expiration queue",
2072 key: :attachments_cleanup,
2074 description: "Attachment deletion queue",
2080 description: "Background queue",
2084 key: :federator_incoming,
2086 description: "Incoming federation queue",
2090 key: :federator_outgoing,
2092 description: "Outgoing federation queue",
2098 description: "Email sender queue, see Pleroma.Emails.Mailer",
2102 key: :scheduled_activities,
2104 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2108 key: :transmogrifier,
2110 description: "Transmogrifier queue",
2116 description: "Web push notifications queue",
2123 type: {:list, :tuple},
2124 description: "Settings for cron background jobs",
2126 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2127 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2128 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2129 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2130 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2139 description: "Includes custom worker options not interpretable directly by `Oban`",
2143 type: {:keyword, :integer},
2144 description: "Max retry attempts for failed jobs, per `Oban` queue",
2146 federator_incoming: 5,
2147 federator_outgoing: 5
2154 key: Pleroma.Web.Metadata,
2156 description: "Metadata-related settings",
2160 type: {:list, :module},
2161 description: "List of metadata providers to enable",
2163 Pleroma.Web.Metadata.Providers.OpenGraph,
2164 Pleroma.Web.Metadata.Providers.TwitterCard,
2165 Pleroma.Web.Metadata.Providers.RelMe,
2166 Pleroma.Web.Metadata.Providers.Feed
2171 label: "Unfurl NSFW",
2173 description: "When enabled NSFW attachments will be shown in previews"
2182 "If enabled the instance will parse metadata from attached links to generate link previews",
2187 description: "Enables RichMedia parsing of URLs"
2191 type: {:list, :string},
2192 description: "List of hosts which will be ignored by the metadata parser",
2193 suggestions: ["accounts.google.com", "xss.website"]
2197 label: "Ignore TLD",
2198 type: {:list, :string},
2199 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2200 suggestions: ["local", "localdomain", "lan"]
2204 type: {:list, :module},
2206 "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.",
2208 Pleroma.Web.RichMedia.Parsers.OEmbed,
2209 Pleroma.Web.RichMedia.Parsers.TwitterCard
2214 label: "TTL setters",
2215 type: {:list, :module},
2217 "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.",
2219 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2225 group: :auto_linker,
2227 label: "Auto Linker",
2229 description: "Configuration for the auto_linker library",
2233 type: [:string, false],
2234 description: "Specify the class to be added to the generated link. Disable to clear.",
2235 suggestions: ["auto-linker", false]
2239 type: [:string, false],
2240 description: "Override the rel attribute. Disable to clear.",
2241 suggestions: ["ugc", "noopener noreferrer", false]
2246 description: "Link URLs will open in new window/tab"
2250 type: [:integer, false],
2252 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2253 suggestions: [15, false]
2258 description: "Strip the scheme prefix"
2263 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2269 key: Pleroma.ScheduledActivity,
2271 description: "Scheduled activities settings",
2274 key: :daily_user_limit,
2277 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2281 key: :total_user_limit,
2284 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2290 description: "Whether scheduled activities are sent to the job queue to be executed"
2296 key: Pleroma.ActivityExpiration,
2298 description: "Expired activity settings",
2303 description: "Whether expired activities will be sent to the job queue to be deleted"
2309 label: "Pleroma Authenticator",
2311 description: "Authenticator",
2314 key: Pleroma.Web.Auth.Authenticator,
2316 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2326 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2327 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2328 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2329 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2334 description: "Enables LDAP authentication"
2339 description: "LDAP server hostname",
2340 suggestions: ["localhosts"]
2345 description: "LDAP port, e.g. 389 or 636",
2346 suggestions: [389, 636]
2352 description: "Enable to use SSL, usually implies the port 636"
2356 label: "SSL options",
2358 description: "Additional SSL options",
2359 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2364 description: "Path to file with PEM encoded cacerts",
2365 suggestions: ["path/to/file/with/PEM/cacerts"]
2370 description: "Type of cert verification",
2371 suggestions: [:verify_peer]
2379 description: "Enable to use STARTTLS, usually implies the port 389"
2383 label: "TLS options",
2385 description: "Additional TLS options",
2386 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2391 description: "Path to file with PEM encoded cacerts",
2392 suggestions: ["path/to/file/with/PEM/cacerts"]
2397 description: "Type of cert verification",
2398 suggestions: [:verify_peer]
2405 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2406 suggestions: ["dc=example,dc=com"]
2413 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2422 description: "Authentication / authorization settings",
2425 key: :enforce_oauth_admin_scope_usage,
2426 label: "Enforce OAuth admin scope usage",
2429 "OAuth admin scope requirement toggle. " <>
2430 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2431 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2432 "`is_admin` user flag grants access to admin-specific actions."
2435 key: :auth_template,
2438 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2439 suggestions: ["show.html"]
2442 key: :oauth_consumer_template,
2443 label: "OAuth consumer template",
2446 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2447 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2448 suggestions: ["consumer.html"]
2451 key: :oauth_consumer_strategies,
2452 label: "OAuth consumer strategies",
2453 type: {:list, :string},
2455 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2456 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2457 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2458 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2464 key: :email_notifications,
2466 description: "Email notifications settings",
2472 "emails of \"what you've missed\" for users who have been inactive for a while",
2476 schedule: "0 0 * * 0",
2478 inactivity_threshold: 7
2486 description: "Globally enable or disable digest emails"
2492 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2493 suggestions: ["0 0 * * 0"]
2498 description: "Minimum interval between digest emails to one user",
2502 key: :inactivity_threshold,
2504 description: "Minimum user inactivity threshold",
2513 key: Pleroma.Emails.UserEmail,
2515 description: "Email template settings",
2520 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2521 suggestions: ["some/path/logo.png"]
2526 description: "a map with color settings for email templates.",
2529 link_color: "#d8a070",
2530 background_color: "#2C3645",
2531 content_background_color: "#1B2635",
2532 header_color: "#d8a070",
2533 text_color: "#b9b9ba",
2534 text_muted_color: "#b9b9ba"
2541 suggestions: ["#d8a070"]
2544 key: :background_color,
2546 suggestions: ["#2C3645"]
2549 key: :content_background_color,
2551 suggestions: ["#1B2635"]
2556 suggestions: ["#d8a070"]
2561 suggestions: ["#b9b9ba"]
2564 key: :text_muted_color,
2566 suggestions: ["#b9b9ba"]
2574 key: Pleroma.Emails.NewUsersDigestEmail,
2576 description: "New users admin email digest",
2581 description: "Enables new users admin digest email when `true`",
2582 suggestions: [false]
2591 description: "Configure OAuth 2 provider capabilities",
2594 key: :token_expires_in,
2596 description: "The lifetime in seconds of the access token",
2600 key: :issue_new_refresh_token,
2603 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2606 key: :clean_expired_tokens,
2608 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2618 key: :shortcode_globs,
2619 type: {:list, :string},
2620 description: "Location of custom emoji files. * can be used as a wildcard.",
2621 suggestions: ["/emoji/custom/**/*.png"]
2624 key: :pack_extensions,
2625 type: {:list, :string},
2627 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2628 suggestions: [".png", ".gif"]
2632 type: {:keyword, :string, {:list, :string}},
2634 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2635 " and the value is the location or array of locations. * can be used as a wildcard.",
2637 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2641 key: :default_manifest,
2644 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2645 " Currently only one manifest can be added (no arrays).",
2646 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2649 key: :shared_pack_cache_seconds_per_file,
2650 label: "Shared pack cache s/file",
2653 "When an emoji pack is shared, the archive is created and cached in memory" <>
2654 " for this amount of seconds multiplied by the number of files.",
2664 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2668 type: [:tuple, {:list, :tuple}],
2669 description: "For the search requests (account & status search etc.)",
2670 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2674 type: [:tuple, {:list, :tuple}],
2675 description: "For requests to timelines (each timeline has it's own limiter)",
2676 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2679 key: :app_account_creation,
2680 type: [:tuple, {:list, :tuple}],
2681 description: "For registering user accounts from the same IP address",
2682 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2685 key: :relations_actions,
2686 type: [:tuple, {:list, :tuple}],
2687 description: "For actions on relationships with all users (follow, unfollow)",
2688 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2691 key: :relation_id_action,
2692 label: "Relation ID action",
2693 type: [:tuple, {:list, :tuple}],
2694 description: "For actions on relation with a specific user (follow, unfollow)",
2695 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2698 key: :statuses_actions,
2699 type: [:tuple, {:list, :tuple}],
2701 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2702 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2705 key: :status_id_action,
2706 label: "Status ID action",
2707 type: [:tuple, {:list, :tuple}],
2709 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2710 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2713 key: :authentication,
2714 type: [:tuple, {:list, :tuple}],
2715 description: "For authentication create / password check / user existence check requests",
2716 suggestions: [{60_000, 15}]
2725 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2726 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2731 description: "Enables SSH"
2736 description: "Dir with SSH keys",
2737 suggestions: ["/some/path/ssh_keys"]
2742 description: "Handler module",
2743 suggestions: ["Pleroma.BBS.Handler"]
2748 description: "Port to connect",
2749 suggestions: [10_022]
2752 key: :password_authenticator,
2754 description: "Authenticator module",
2755 suggestions: ["Pleroma.BBS.Authenticator"]
2761 label: "Mime Types",
2763 description: "Mime Types settings",
2770 "application/xml" => ["xml"],
2771 "application/xrd+xml" => ["xrd+xml"],
2772 "application/jrd+json" => ["jrd+json"],
2773 "application/activity+json" => ["activity+json"],
2774 "application/ld+json" => ["activity+json"]
2779 key: "application/xml",
2780 type: {:list, :string},
2781 suggestions: ["xml"]
2784 key: "application/xrd+xml",
2785 type: {:list, :string},
2786 suggestions: ["xrd+xml"]
2789 key: "application/jrd+json",
2790 type: {:list, :string},
2791 suggestions: ["jrd+json"]
2794 key: "application/activity+json",
2795 type: {:list, :string},
2796 suggestions: ["activity+json"]
2799 key: "application/ld+json",
2800 type: {:list, :string},
2801 suggestions: ["activity+json"]
2811 description: "Pleroma chat settings",
2824 description: "HTTP settings",
2829 type: [:string, :tuple],
2830 description: "Proxy URL",
2831 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2834 key: :send_user_agent,
2839 type: [:string, :atom],
2841 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2842 suggestions: ["Pleroma", :default]
2847 description: "Adapter specific options",
2853 label: "SSL Options",
2854 description: "SSL options for HTTP adapter",
2858 type: {:list, :atom},
2859 description: "List of TLS version to use",
2860 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2871 label: "Markup Settings",
2875 key: :allow_inline_images,
2879 key: :allow_headings,
2892 type: {:list, :module},
2894 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2895 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2905 key: :deny_follow_blocked,
2913 key: :mrf_normalize_markup,
2914 label: "MRF Normalize Markup",
2915 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2921 suggestions: [Pleroma.HTML.Scrubber.Default]
2931 key: :restricted_nicknames,
2932 type: {:list, :string},
2951 "ostatus_subscribe",
2970 label: "CORS plug config",
2976 suggestions: [86_400]
2980 type: {:list, :string},
2981 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2985 type: {:list, :string},
2988 "X-RateLimit-Reset",
2989 "X-RateLimit-Limit",
2990 "X-RateLimit-Remaining",
3001 type: {:list, :string},
3002 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3008 key: Pleroma.Plugs.RemoteIp,
3011 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3012 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3018 description: "Enable/disable the plug. Default: disabled."
3022 type: {:list, :string},
3024 "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]`."
3028 type: {:list, :string},
3030 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3034 type: {:list, :string},
3036 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3042 key: :web_cache_ttl,
3043 label: "Web cache TTL",
3046 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3052 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3053 suggestions: [30_000, nil]
3056 key: :activity_pub_question,
3058 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3059 suggestions: [30_000]
3069 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3074 description: "Enables the rendering of static HTML. Default: disabled."
3082 description: "Configure feed rendering",
3087 description: "Configure title rendering",
3092 description: "Maximum number of characters before truncating title",
3098 description: "Replacement which will be used after truncating string",
3099 suggestions: ["..."]
3107 key: :mrf_object_age,
3108 label: "MRF Object Age",
3111 description: "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3116 description: "Required age (in seconds) of a post before actions are taken.",
3117 suggestions: [172_800]
3121 type: {:list, :atom},
3123 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3124 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3125 "`:reject` rejects the message entirely",
3126 suggestions: [:delist, :strip_followers, :reject]
3134 description: "Custom Runtime Modules",
3139 description: "A path to custom Elixir modules (such as MRF policies)."
3147 description: "Settings for notifications streamer",
3152 description: "Number of workers to send notifications",
3156 key: :overflow_workers,
3158 description: "Maximum number of workers created if pool is empty",
3165 key: :connections_pool,
3167 description: "Advanced settings for `gun` connections pool",
3170 key: :checkin_timeout,
3172 description: "Timeout to checkin connection from pool. Default: 250ms.",
3176 key: :max_connections,
3178 description: "Maximum number of connections in the pool. Default: 250 connections.",
3185 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3189 key: :retry_timeout,
3192 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3196 key: :await_up_timeout,
3198 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3207 description: "Advanced settings for `gun` workers pools",
3212 description: "Settings for federation pool.",
3217 description: "Number workers in the pool.",
3223 description: "Number of additional workers if pool is under load.",
3229 description: "Timeout while `gun` will wait for response.",
3230 suggestions: [150_000]
3237 description: "Settings for media pool.",
3242 description: "Number workers in the pool.",
3248 description: "Number of additional workers if pool is under load.",
3254 description: "Timeout while `gun` will wait for response.",
3255 suggestions: [150_000]
3262 description: "Settings for upload pool.",
3267 description: "Number workers in the pool.",
3273 description: "Number of additional workers if pool is under load.",
3279 description: "Timeout while `gun` will wait for response.",
3280 suggestions: [300_000]
3287 description: "Settings for default pool.",
3292 description: "Number workers in the pool.",
3298 description: "Number of additional workers if pool is under load.",
3304 description: "Timeout while `gun` will wait for response.",
3305 suggestions: [10_000]
3313 key: :hackney_pools,
3315 description: "Advanced settings for `hackney` connections pools",
3320 description: "Settings for federation pool.",
3323 key: :max_connections,
3325 description: "Number workers in the pool.",
3331 description: "Timeout while `hackney` will wait for response.",
3332 suggestions: [150_000]
3339 description: "Settings for media pool.",
3342 key: :max_connections,
3344 description: "Number workers in the pool.",
3350 description: "Timeout while `hackney` will wait for response.",
3351 suggestions: [150_000]
3358 description: "Settings for upload pool.",
3361 key: :max_connections,
3363 description: "Number workers in the pool.",
3369 description: "Timeout while `hackney` will wait for response.",
3370 suggestions: [300_000]
3378 key: :restrict_unauthenticated,
3381 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3386 description: "Settings for public and federated timelines.",
3391 description: "Disallow view public timeline."
3396 description: "Disallow view federated timeline."
3403 description: "Settings for user profiles.",
3408 description: "Disallow view local user profiles."
3413 description: "Disallow view remote user profiles."
3420 description: "Settings for statuses.",
3425 description: "Disallow view local statuses."
3430 description: "Disallow view remote statuses."
3438 key: Pleroma.Web.ApiSpec.CastAndValidate,
3445 "Enables strict input validation (useful in development, not recommended in production)",
3446 suggestions: [false]