2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
26 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
30 type: {:list, :module},
32 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
33 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
39 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
45 description: "Base URL for the uploads, needed if you use CDN",
47 "https://cdn-host.com"
54 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
58 label: "Proxy Options",
60 description: "Options for Pleroma.ReverseProxy",
62 redirect_on_failure: false,
63 max_body_length: 25 * 1_048_576,
65 follow_redirect: true,
71 key: :redirect_on_failure,
74 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
75 "Any error during body processing will not be redirected as the response is chunked."
78 key: :max_body_length,
81 "Limits the content length to be approximately the " <>
82 "specified length. It is validated with the `content-length` header and also verified when proxying."
88 description: "HTTP options",
93 description: "Adapter specific options",
99 description: "SSL options for HTTP adapter",
103 type: {:list, :atom},
104 description: "List of TLS versions to use",
105 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
114 type: [:string, :tuple],
115 description: "Proxy URL",
116 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
123 key: :filename_display_max_length,
125 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
131 key: Pleroma.Uploaders.Local,
133 description: "Local uploader-related settings",
138 description: "Path where user's uploads will be saved",
147 key: Pleroma.Uploaders.S3,
149 description: "S3 uploader-related settings",
154 description: "S3 bucket",
160 key: :bucket_namespace,
162 description: "S3 bucket namespace",
163 suggestions: ["pleroma"]
166 key: :public_endpoint,
168 description: "S3 endpoint",
169 suggestions: ["https://s3.amazonaws.com"]
172 key: :truncated_namespace,
175 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
176 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
179 key: :streaming_enabled,
182 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
188 key: Pleroma.Upload.Filter.Mogrify,
190 description: "Uploads mogrify filter settings",
194 type: [:string, {:list, :string}, {:list, :tuple}],
196 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
197 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
208 key: Pleroma.Upload.Filter.AnonymizeFilename,
210 description: "Filter replaces the filename of the upload",
216 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
217 " filename extension by using {extension}, for example custom-file-name.{extension}.",
219 "custom-file-name.{extension}"
226 key: Pleroma.Emails.Mailer,
228 description: "Mailer-related settings",
234 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
235 " or Swoosh.Adapters.Local for in-memory mailbox",
237 Swoosh.Adapters.SMTP,
238 Swoosh.Adapters.Sendgrid,
239 Swoosh.Adapters.Sendmail,
240 Swoosh.Adapters.Mandrill,
241 Swoosh.Adapters.Mailgun,
242 Swoosh.Adapters.Mailjet,
243 Swoosh.Adapters.Postmark,
244 Swoosh.Adapters.SparkPost,
245 Swoosh.Adapters.AmazonSES,
247 Swoosh.Adapters.SocketLabs,
248 Swoosh.Adapters.Gmail,
249 Swoosh.Adapters.Local
255 description: "Allow/disallow send emails"
258 group: {:subgroup, Swoosh.Adapters.SMTP},
261 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
262 suggestions: ["smtp.gmail.com"]
265 group: {:subgroup, Swoosh.Adapters.SMTP},
268 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
269 suggestions: ["pleroma"]
272 group: {:subgroup, Swoosh.Adapters.SMTP},
275 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
276 suggestions: ["password"]
279 group: {:subgroup, Swoosh.Adapters.SMTP},
283 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
286 group: {:subgroup, Swoosh.Adapters.SMTP},
290 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
291 suggestions: [:always, :never, :if_available]
294 group: {:subgroup, Swoosh.Adapters.SMTP},
297 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
298 suggestions: [:always, :never, :if_available]
301 group: {:subgroup, Swoosh.Adapters.SMTP},
304 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
308 group: {:subgroup, Swoosh.Adapters.SMTP},
311 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
315 group: {:subgroup, Swoosh.Adapters.SMTP},
317 label: "No MX lookups",
319 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
322 group: {:subgroup, Swoosh.Adapters.Sendgrid},
326 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
327 suggestions: ["my-api-key"]
330 group: {:subgroup, Swoosh.Adapters.Sendmail},
333 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
334 suggestions: ["/usr/bin/sendmail"]
337 group: {:subgroup, Swoosh.Adapters.Sendmail},
340 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
341 suggestions: ["-N delay,failure,success"]
344 group: {:subgroup, Swoosh.Adapters.Sendmail},
347 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
350 group: {:subgroup, Swoosh.Adapters.Mandrill},
354 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
355 suggestions: ["my-api-key"]
358 group: {:subgroup, Swoosh.Adapters.Mailgun},
362 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
363 suggestions: ["my-api-key"]
366 group: {:subgroup, Swoosh.Adapters.Mailgun},
369 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
370 suggestions: ["pleroma.com"]
373 group: {:subgroup, Swoosh.Adapters.Mailjet},
377 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
378 suggestions: ["my-api-key"]
381 group: {:subgroup, Swoosh.Adapters.Mailjet},
384 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
385 suggestions: ["my-secret-key"]
388 group: {:subgroup, Swoosh.Adapters.Postmark},
392 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
393 suggestions: ["my-api-key"]
396 group: {:subgroup, Swoosh.Adapters.SparkPost},
400 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
401 suggestions: ["my-api-key"]
404 group: {:subgroup, Swoosh.Adapters.SparkPost},
407 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
408 suggestions: ["https://api.sparkpost.com/api/v1"]
411 group: {:subgroup, Swoosh.Adapters.AmazonSES},
414 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
415 suggestions: ["us-east-1", "us-east-2"]
418 group: {:subgroup, Swoosh.Adapters.AmazonSES},
421 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
422 suggestions: ["aws-access-key"]
425 group: {:subgroup, Swoosh.Adapters.AmazonSES},
428 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
429 suggestions: ["aws-secret-key"]
432 group: {:subgroup, Swoosh.Adapters.Dyn},
436 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
437 suggestions: ["my-api-key"]
440 group: {:subgroup, Swoosh.Adapters.SocketLabs},
443 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
446 group: {:subgroup, Swoosh.Adapters.SocketLabs},
450 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
453 group: {:subgroup, Swoosh.Adapters.Gmail},
456 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
463 description: "`Swoosh.Adapters.Local` adapter specific settings",
466 group: {:subgroup, Swoosh.Adapters.Local},
469 description: "Run the preview server together as part of your app"
472 group: {:subgroup, Swoosh.Adapters.Local},
475 description: "The preview server port",
483 label: "URI Schemes",
485 description: "URI schemes related settings",
489 type: {:list, :string},
490 description: "List of the scheme part that is considered valid to be an URL",
515 description: "Instance-related settings",
520 description: "Name of the instance",
527 label: "Admin Email Address",
529 description: "Email used to reach an Administrator/Moderator of the instance",
536 label: "Sender Email Address",
538 description: "Envelope FROM address for mail sent via Pleroma",
547 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
555 description: "Posts character limit (CW/Subject included in the counter)",
563 description: "Character limit of the instance chat messages",
571 description: "Hard character limit beyond which remote posts will be dropped",
579 description: "File size limit of uploads (except for avatar, background, banner)",
585 key: :avatar_upload_limit,
587 description: "File size limit of user's profile avatars",
593 key: :background_upload_limit,
595 description: "File size limit of user's profile backgrounds",
601 key: :banner_upload_limit,
603 description: "File size limit of user's profile banners",
611 description: "A map with poll limits for local polls",
615 max_option_chars: 200,
617 max_expiration: 31_536_000
624 description: "Maximum number of options",
628 key: :max_option_chars,
630 description: "Maximum number of characters per option",
634 key: :min_expiration,
636 description: "Minimum expiration time (in seconds)",
640 key: :max_expiration,
642 description: "Maximum expiration time (in seconds)",
648 key: :registrations_open,
651 "Enable registrations for anyone. Invitations require this setting to be disabled."
654 key: :invites_enabled,
657 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
660 key: :account_activation_required,
662 description: "Require users to confirm their emails before signing in"
667 description: "Enable federation with other instances"
670 key: :federation_incoming_replies_max_depth,
671 label: "Fed. incoming replies max depth",
674 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
675 " 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.",
681 key: :federation_reachability_timeout_days,
682 label: "Fed. reachability timeout days",
685 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
693 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
699 "Makes the client API in authenticated mode-only except for user-profiles." <>
700 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
701 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
704 key: :quarantined_instances,
705 type: {:list, :string},
707 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
714 key: :managed_config,
717 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
722 description: "Instance static directory",
728 key: :allowed_post_formats,
729 type: {:list, :string},
730 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
739 key: :extended_nickname_format,
742 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
743 " This will break federation with older software for theses nicknames."
746 key: :cleanup_attachments,
749 Enable to remove associated attachments when status is removed.
750 This will not affect duplicates and attachments without status.
751 Enabling this will increase load to database when deleting statuses on larger instances.
755 key: :max_pinned_statuses,
757 description: "The maximum number of pinned statuses. 0 will disable the feature.",
765 key: :autofollowed_nicknames,
766 type: {:list, :string},
768 "Set to nicknames of (local) users that every new user should automatically follow",
777 key: :attachment_links,
779 description: "Enable to automatically add attachment link text to statuses"
782 key: :welcome_message,
785 "A message that will be sent to a newly registered users as a direct message",
787 "Hi, @username! Welcome on board!"
791 key: :welcome_user_nickname,
793 description: "The nickname of the local user that sends the welcome message",
799 key: :max_report_comment_size,
801 description: "The maximum size of the report comment. Default: 1000.",
807 key: :safe_dm_mentions,
808 label: "Safe DM mentions",
811 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
812 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
818 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
821 key: :remote_post_retention_days,
824 "The default amount of days to retain remote posts when pruning the database",
830 key: :user_bio_length,
832 description: "A user bio maximum length. Default: 5000.",
838 key: :user_name_length,
840 description: "A user name maximum length. Default: 100.",
846 key: :skip_thread_containment,
848 description: "Skip filtering out broken threads. Default: enabled."
851 key: :limit_to_local_content,
852 type: {:dropdown, :atom},
854 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
862 key: :max_account_fields,
864 description: "The maximum number of custom fields in the user profile. Default: 10.",
870 key: :max_remote_account_fields,
873 "The maximum number of custom fields in the remote user profile. Default: 20.",
879 key: :account_field_name_length,
881 description: "An account field name maximum length. Default: 512.",
887 key: :account_field_value_length,
889 description: "An account field value maximum length. Default: 2048.",
895 key: :external_user_synchronization,
897 description: "Enabling following/followers counters synchronization for external users"
900 key: :multi_factor_authentication,
902 description: "Multi-factor authentication settings",
905 totp: [digits: 6, period: 30],
906 backup_codes: [number: 5, length: 16]
912 label: "TOTP settings",
914 description: "TOTP settings",
915 suggestions: [digits: 6, period: 30],
922 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
929 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
936 description: "MFA backup codes settings",
937 suggestions: [number: 5, length: 16],
943 description: "Number of backup codes to generate."
950 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
957 key: :instance_thumbnail,
960 "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.",
961 suggestions: ["/instance/thumbnail.jpeg"]
968 description: "Logger-related settings",
972 type: [:atom, :tuple, :module],
974 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
975 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
983 label: "ExSyslogger",
984 description: "ExSyslogger-related settings",
988 type: {:dropdown, :atom},
989 description: "Log level",
990 suggestions: [:debug, :info, :warn, :error]
996 "A string that's prepended to every message, and is typically set to the app name",
997 suggestions: ["pleroma"]
1002 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1003 suggestions: ["$metadata[$level] $message"]
1007 type: {:list, :atom},
1008 suggestions: [:request_id]
1016 label: "Console Logger",
1017 description: "Console logger settings",
1021 type: {:dropdown, :atom},
1022 description: "Log level",
1023 suggestions: [:debug, :info, :warn, :error]
1028 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1029 suggestions: ["$metadata[$level] $message"]
1033 type: {:list, :atom},
1034 suggestions: [:request_id]
1041 label: "Quack Logger",
1042 description: "Quack-related settings",
1046 type: {:dropdown, :atom},
1047 description: "Log level",
1048 suggestions: [:debug, :info, :warn, :error]
1052 type: {:list, :atom},
1053 description: "Configure which metadata you want to report on",
1070 label: "Webhook URL",
1072 description: "Configure the Slack incoming webhook",
1073 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1079 key: :frontend_configurations,
1082 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1083 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1084 "add your own configuration your settings all fields must be complete.",
1088 label: "Pleroma FE",
1090 description: "Settings for Pleroma FE",
1093 alwaysShowSubjectInput: true,
1094 background: "/static/aurora_borealis.jpg",
1095 collapseMessageWithSubject: false,
1098 hideFilteredStatuses: false,
1099 hideMutedPosts: false,
1100 hidePostStats: false,
1101 hideSitename: false,
1102 hideUserStats: false,
1103 loginMethod: "password",
1104 logo: "/static/logo.png",
1107 minimalScopesMode: false,
1108 noAttachmentLinks: false,
1109 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1110 postContentType: "text/plain",
1111 redirectRootLogin: "/main/friends",
1112 redirectRootNoLogin: "/main/all",
1114 sidebarRight: false,
1115 showFeaturesPanel: true,
1116 showInstanceSpecificPanel: false,
1117 subjectLineBehavior: "email",
1118 theme: "pleroma-dark",
1119 webPushNotifications: false
1124 key: :alwaysShowSubjectInput,
1125 label: "Always show subject input",
1127 description: "When disabled, auto-hide the subject field if it's empty"
1133 "URL of the background, unless viewing a user profile with a background that is set",
1134 suggestions: ["/images/city.jpg"]
1137 key: :collapseMessageWithSubject,
1138 label: "Collapse message with subject",
1141 "When a message has a subject (aka Content Warning), collapse it by default"
1145 label: "PleromaFE Chat",
1147 description: "Disables PleromaFE Chat component"
1153 description: "Enables green text on lines prefixed with the > character"
1156 key: :hideFilteredStatuses,
1157 label: "Hide Filtered Statuses",
1159 description: "Hides filtered statuses from timelines"
1162 key: :hideMutedPosts,
1163 label: "Hide Muted Posts",
1165 description: "Hides muted statuses from timelines"
1168 key: :hidePostStats,
1169 label: "Hide post stats",
1171 description: "Hide notices statistics (repeats, favorites, ...)"
1175 label: "Hide Sitename",
1177 description: "Hides instance name from PleromaFE banner"
1180 key: :hideUserStats,
1181 label: "Hide user stats",
1184 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1189 description: "URL of the logo, defaults to Pleroma's logo",
1190 suggestions: ["/static/logo.png"]
1194 label: "Logo margin",
1197 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1198 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1199 suggestions: [".1em"]
1206 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1207 "If you want a colorful logo you must disable logoMask."
1210 key: :minimalScopesMode,
1211 label: "Minimal scopes mode",
1214 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1215 "Also prevents replying to a DM with a public post from PleromaFE."
1218 key: :nsfwCensorImage,
1219 label: "NSFW Censor Image",
1222 "URL of the image to use for hiding NSFW media attachments in the timeline",
1223 suggestions: ["/static/img/nsfw.74818f9.png"]
1226 key: :postContentType,
1227 label: "Post Content Type",
1228 type: {:dropdown, :atom},
1229 description: "Default post formatting option",
1230 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1233 key: :redirectRootNoLogin,
1234 label: "Redirect root no login",
1237 "Relative URL which indicates where to redirect when a user isn't logged in",
1238 suggestions: ["/main/all"]
1241 key: :redirectRootLogin,
1242 label: "Redirect root login",
1245 "Relative URL which indicates where to redirect when a user is logged in",
1246 suggestions: ["/main/friends"]
1250 label: "Scope copy",
1252 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1256 label: "Sidebar on Right",
1258 description: "Change alignment of sidebar and panels to the right"
1261 key: :showFeaturesPanel,
1262 label: "Show instance features panel",
1265 "Enables panel displaying functionality of the instance on the About page"
1268 key: :showInstanceSpecificPanel,
1269 label: "Show instance specific panel",
1271 description: "Whether to show the instance's custom panel"
1274 key: :subjectLineBehavior,
1275 label: "Subject line behavior",
1277 description: "Allows changing the default behaviour of subject lines in replies.
1278 `email`: copy and preprend re:, as in email,
1279 `masto`: copy verbatim, as in Mastodon,
1280 `noop`: don't copy the subject.",
1281 suggestions: ["email", "masto", "noop"]
1286 description: "Which theme to use. Available themes are defined in styles.json",
1287 suggestions: ["pleroma-dark"]
1295 description: "Settings for Masto FE",
1298 showInstanceSpecificPanel: true
1303 key: :showInstanceSpecificPanel,
1304 label: "Show instance specific panel",
1306 description: "Whenether to show the instance's specific panel"
1317 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1321 type: {:keyword, :map},
1323 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1326 url: "/images/pleroma-fox-tan-smol.png",
1327 mime_type: "image/png"
1329 pleroma_fox_tan_shy: %{
1330 url: "/images/pleroma-fox-tan-shy.png",
1331 mime_type: "image/png"
1336 key: :default_mascot,
1339 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1345 key: :default_user_avatar,
1347 description: "URL of the default user avatar",
1348 suggestions: ["/images/avi.png"]
1357 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1361 type: {:list, :map},
1362 description: "Describe the icons of the app",
1365 src: "/static/logo.png"
1368 src: "/static/icon.png",
1372 src: "/static/icon.ico",
1373 sizes: "72x72 96x96 128x128 256x256"
1380 description: "Describe the theme color of the app",
1381 suggestions: ["#282c37", "mediumpurple"]
1384 key: :background_color,
1386 description: "Describe the background color of the app",
1387 suggestions: ["#191b22", "aliceblue"]
1397 description: "General MRF settings",
1401 type: [:module, {:list, :module}],
1403 "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.",
1404 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1408 label: "MRF transparency",
1411 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1414 key: :transparency_exclusions,
1415 label: "MRF transparency exclusions",
1416 type: {:list, :string},
1418 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1429 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1430 label: "MRF Simple",
1432 description: "Simple ingress policies",
1435 key: :media_removal,
1436 type: {:list, :string},
1437 description: "List of instances to strip media attachments from",
1438 suggestions: ["example.com", "*.example.com"]
1442 label: "Media NSFW",
1443 type: {:list, :string},
1444 description: "List of instances to tag all media as NSFW (sensitive) from",
1445 suggestions: ["example.com", "*.example.com"]
1448 key: :federated_timeline_removal,
1449 type: {:list, :string},
1451 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1452 suggestions: ["example.com", "*.example.com"]
1456 type: {:list, :string},
1457 description: "List of instances to reject activities from (except deletes)",
1458 suggestions: ["example.com", "*.example.com"]
1462 type: {:list, :string},
1463 description: "List of instances to only accept activities from (except deletes)",
1464 suggestions: ["example.com", "*.example.com"]
1467 key: :report_removal,
1468 type: {:list, :string},
1469 description: "List of instances to reject reports from",
1470 suggestions: ["example.com", "*.example.com"]
1473 key: :avatar_removal,
1474 type: {:list, :string},
1475 description: "List of instances to strip avatars from",
1476 suggestions: ["example.com", "*.example.com"]
1479 key: :banner_removal,
1480 type: {:list, :string},
1481 description: "List of instances to strip banners from",
1482 suggestions: ["example.com", "*.example.com"]
1485 key: :reject_deletes,
1486 type: {:list, :string},
1487 description: "List of instances to reject deletions from",
1488 suggestions: ["example.com", "*.example.com"]
1494 key: :mrf_activity_expiration,
1496 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1497 label: "MRF Activity Expiration Policy",
1499 description: "Adds automatic expiration to all local activities",
1504 description: "Default global expiration time for all local activities (in days)",
1505 suggestions: [90, 365]
1513 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1514 label: "MRF Subchain",
1517 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1518 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1522 type: {:map, {:list, :string}},
1523 description: "Matches a series of regular expressions against the actor field",
1526 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1534 key: :mrf_rejectnonpublic,
1536 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1537 description: "RejectNonPublic drops posts with non-public visibility settings.",
1538 label: "MRF Reject Non Public",
1542 key: :allow_followersonly,
1543 label: "Allow followers-only",
1545 description: "Whether to allow followers-only posts"
1550 description: "Whether to allow direct messages"
1556 key: :mrf_hellthread,
1558 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1559 label: "MRF Hellthread",
1561 description: "Block messages with excessive user mentions",
1564 key: :delist_threshold,
1567 "Number of mentioned users after which the message gets removed from timelines and" <>
1568 "disables notifications. Set to 0 to disable.",
1572 key: :reject_threshold,
1575 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1584 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1585 label: "MRF Keyword",
1587 description: "Reject or Word-Replace messages with a keyword or regex",
1591 type: {:list, :string},
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: {:list, :string},
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: {:list, :tuple},
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 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
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 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1634 label: "MRF Vocabulary",
1636 description: "Filter messages which belong to certain activity vocabularies",
1640 type: {:list, :string},
1642 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1643 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1647 type: {:list, :string},
1649 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1650 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1656 # key: :mrf_user_allowlist,
1658 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1661 # "The keys in this section are the domain names that the policy should apply to." <>
1662 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1664 # %{"example.org" => ["https://example.org/users/admin"]}
1672 description: "Media proxy",
1677 description: "Enables proxying of remote media to the instance's proxy"
1684 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1685 suggestions: ["https://example.com"]
1693 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1699 description: "Enables invalidate media cache"
1704 description: "Module which will be used to cache purge.",
1706 Pleroma.Web.MediaProxy.Invalidation.Script,
1707 Pleroma.Web.MediaProxy.Invalidation.Http
1714 label: "Proxy Options",
1716 description: "Options for Pleroma.ReverseProxy",
1718 redirect_on_failure: false,
1719 max_body_length: 25 * 1_048_576,
1721 follow_redirect: true,
1727 key: :redirect_on_failure,
1730 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1731 "Any error during body processing will not be redirected as the response is chunked."
1734 key: :max_body_length,
1737 "Limits the content length to be approximately the " <>
1738 "specified length. It is validated with the `content-length` header and also verified when proxying."
1744 description: "HTTP options",
1749 description: "Adapter specific options",
1754 label: "SSL Options",
1755 description: "SSL options for HTTP adapter",
1759 type: {:list, :atom},
1760 description: "List of TLS version to use",
1761 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1770 type: [:string, :tuple],
1771 description: "Proxy URL",
1772 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1780 type: {:list, :string},
1781 description: "List of hosts with scheme to bypass the mediaproxy",
1782 suggestions: ["http://example.com"]
1788 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1790 description: "HTTP invalidate settings",
1795 description: "HTTP method of request. Default: :purge"
1799 type: {:keyword, :string},
1800 description: "HTTP headers of request",
1801 suggestions: [{"x-refresh", 1}]
1806 description: "Request options",
1810 type: {:map, :string}
1818 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1820 description: "Script invalidate settings",
1825 description: "Path to shell script. Which will run purge cache.",
1826 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1834 description: "Gopher settings",
1839 description: "Enables the gopher interface"
1845 description: "IP address to bind to",
1846 suggestions: [{0, 0, 0, 0}]
1851 description: "Port to bind to",
1857 description: "Port advertised in URLs (optional, defaults to port)",
1865 label: "ActivityPub",
1867 description: "ActivityPub-related settings",
1870 key: :unfollow_blocked,
1872 description: "Whether blocks result in people getting unfollowed"
1875 key: :outgoing_blocks,
1877 description: "Whether to federate blocks to other instances"
1880 key: :sign_object_fetches,
1882 description: "Sign object fetches with HTTP signatures"
1885 key: :note_replies_output_limit,
1888 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1891 key: :follow_handshake_timeout,
1893 description: "Following handshake timeout",
1900 key: :http_security,
1901 label: "HTTP security",
1903 description: "HTTP security settings",
1908 description: "Whether the managed content security policy is enabled"
1914 description: "Whether to additionally send a Strict-Transport-Security header"
1918 label: "STS max age",
1920 description: "The maximum age for the Strict-Transport-Security header if sent",
1921 suggestions: [31_536_000]
1925 label: "CT max age",
1927 description: "The maximum age for the Expect-CT header if sent",
1928 suggestions: [2_592_000]
1931 key: :referrer_policy,
1933 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1934 suggestions: ["same-origin", "no-referrer"]
1938 label: "Report URI",
1940 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1941 suggestions: ["https://example.com/report-uri"]
1946 group: :web_push_encryption,
1947 key: :vapid_details,
1948 label: "Vapid Details",
1951 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1957 "A mailto link for the administrative contact." <>
1958 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1959 suggestions: ["mailto:moderators@pleroma.com"]
1964 description: "VAPID public key",
1965 suggestions: ["Public key"]
1970 description: "VAPID private key",
1971 suggestions: ["Private key"]
1977 key: Pleroma.Captcha,
1979 description: "Captcha-related settings",
1984 description: "Whether the captcha should be shown on registration"
1989 description: "The method/service to use for captcha",
1990 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1993 key: :seconds_valid,
1995 description: "The time in seconds for which the captcha is valid",
2002 key: Pleroma.Captcha.Kocaptcha,
2005 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2006 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2011 description: "The kocaptcha endpoint to use",
2012 suggestions: ["https://captcha.kotobank.ch"]
2018 label: "Pleroma Admin Token",
2021 "Allows setting a token that can be used to authenticate requests with admin privileges without a normal user account token. Append the `admin_token` parameter to requests to utilize it. (Please reconsider using HTTP Basic Auth or OAuth-based authentication if possible)",
2026 description: "Admin token",
2028 "Please use a high entropy string or UUID"
2038 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2040 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2041 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2042 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2043 (see https://github.com/sorentwo/oban/issues/52).
2048 type: {:dropdown, :atom},
2049 description: "Logs verbose mode",
2050 suggestions: [false, :error, :warn, :info, :debug]
2054 type: {:keyword, :integer},
2056 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2058 activity_expiration: 10,
2059 attachments_cleanup: 5,
2061 federator_incoming: 50,
2062 federator_outgoing: 50,
2064 scheduled_activities: 10,
2070 key: :activity_expiration,
2072 description: "Activity expiration queue",
2076 key: :attachments_cleanup,
2078 description: "Attachment deletion queue",
2084 description: "Background queue",
2088 key: :federator_incoming,
2090 description: "Incoming federation queue",
2094 key: :federator_outgoing,
2096 description: "Outgoing federation queue",
2102 description: "Email sender queue, see Pleroma.Emails.Mailer",
2106 key: :scheduled_activities,
2108 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2112 key: :transmogrifier,
2114 description: "Transmogrifier queue",
2120 description: "Web push notifications queue",
2127 type: {:list, :tuple},
2128 description: "Settings for cron background jobs",
2130 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2131 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2132 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2133 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2134 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2143 description: "Includes custom worker options not interpretable directly by `Oban`",
2147 type: {:keyword, :integer},
2148 description: "Max retry attempts for failed jobs, per `Oban` queue",
2150 federator_incoming: 5,
2151 federator_outgoing: 5
2158 key: Pleroma.Web.Metadata,
2160 description: "Metadata-related settings",
2164 type: {:list, :module},
2165 description: "List of metadata providers to enable",
2167 Pleroma.Web.Metadata.Providers.OpenGraph,
2168 Pleroma.Web.Metadata.Providers.TwitterCard,
2169 Pleroma.Web.Metadata.Providers.RelMe,
2170 Pleroma.Web.Metadata.Providers.Feed
2175 label: "Unfurl NSFW",
2177 description: "When enabled NSFW attachments will be shown in previews"
2186 "If enabled the instance will parse metadata from attached links to generate link previews",
2191 description: "Enables RichMedia parsing of URLs"
2195 type: {:list, :string},
2196 description: "List of hosts which will be ignored by the metadata parser",
2197 suggestions: ["accounts.google.com", "xss.website"]
2201 label: "Ignore TLD",
2202 type: {:list, :string},
2203 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2204 suggestions: ["local", "localdomain", "lan"]
2208 type: {:list, :module},
2210 "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.",
2212 Pleroma.Web.RichMedia.Parsers.OEmbed,
2213 Pleroma.Web.RichMedia.Parsers.TwitterCard
2218 label: "TTL setters",
2219 type: {:list, :module},
2221 "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.",
2223 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2230 key: Pleroma.Formatter,
2231 label: "Auto Linker",
2234 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2238 type: [:string, false],
2239 description: "Specify the class to be added to the generated link. Disable to clear.",
2240 suggestions: ["auto-linker", false]
2244 type: [:string, false],
2245 description: "Override the rel attribute. Disable to clear.",
2246 suggestions: ["ugc", "noopener noreferrer", false]
2251 description: "Link URLs will open in a new window/tab."
2255 type: [:integer, false],
2257 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2258 suggestions: [15, false]
2263 description: "Strip the scheme prefix."
2268 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2272 type: [:atom, :boolean],
2274 "Set to false to disable TLD validation for URLs/emails. Can be set to :no_scheme to validate TLDs only for URLs without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't)",
2275 suggestions: [:no_scheme, true]
2281 key: Pleroma.ScheduledActivity,
2283 description: "Scheduled activities settings",
2286 key: :daily_user_limit,
2289 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2293 key: :total_user_limit,
2296 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2302 description: "Whether scheduled activities are sent to the job queue to be executed"
2308 key: Pleroma.ActivityExpiration,
2310 description: "Expired activity settings",
2315 description: "Whether expired activities will be sent to the job queue to be deleted"
2321 label: "Pleroma Authenticator",
2323 description: "Authenticator",
2326 key: Pleroma.Web.Auth.Authenticator,
2328 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2338 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2339 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2340 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2341 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2346 description: "Enables LDAP authentication"
2351 description: "LDAP server hostname",
2352 suggestions: ["localhosts"]
2357 description: "LDAP port, e.g. 389 or 636",
2358 suggestions: [389, 636]
2364 description: "Enable to use SSL, usually implies the port 636"
2368 label: "SSL options",
2370 description: "Additional SSL options",
2371 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2376 description: "Path to file with PEM encoded cacerts",
2377 suggestions: ["path/to/file/with/PEM/cacerts"]
2382 description: "Type of cert verification",
2383 suggestions: [:verify_peer]
2391 description: "Enable to use STARTTLS, usually implies the port 389"
2395 label: "TLS options",
2397 description: "Additional TLS options",
2398 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2403 description: "Path to file with PEM encoded cacerts",
2404 suggestions: ["path/to/file/with/PEM/cacerts"]
2409 description: "Type of cert verification",
2410 suggestions: [:verify_peer]
2417 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2418 suggestions: ["dc=example,dc=com"]
2425 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2434 description: "Authentication / authorization settings",
2437 key: :enforce_oauth_admin_scope_usage,
2438 label: "Enforce OAuth admin scope usage",
2441 "OAuth admin scope requirement toggle. " <>
2442 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2443 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2444 "`is_admin` user flag grants access to admin-specific actions."
2447 key: :auth_template,
2450 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2451 suggestions: ["show.html"]
2454 key: :oauth_consumer_template,
2455 label: "OAuth consumer template",
2458 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2459 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2460 suggestions: ["consumer.html"]
2463 key: :oauth_consumer_strategies,
2464 label: "OAuth consumer strategies",
2465 type: {:list, :string},
2467 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2468 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2469 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2470 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2476 key: :email_notifications,
2478 description: "Email notifications settings",
2484 "emails of \"what you've missed\" for users who have been inactive for a while",
2488 schedule: "0 0 * * 0",
2490 inactivity_threshold: 7
2498 description: "Globally enable or disable digest emails"
2504 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2505 suggestions: ["0 0 * * 0"]
2510 description: "Minimum interval between digest emails to one user",
2514 key: :inactivity_threshold,
2516 description: "Minimum user inactivity threshold",
2525 key: Pleroma.Emails.UserEmail,
2527 description: "Email template settings",
2532 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2533 suggestions: ["some/path/logo.png"]
2538 description: "A map with color settings for email templates.",
2541 link_color: "#d8a070",
2542 background_color: "#2C3645",
2543 content_background_color: "#1B2635",
2544 header_color: "#d8a070",
2545 text_color: "#b9b9ba",
2546 text_muted_color: "#b9b9ba"
2553 suggestions: ["#d8a070"]
2556 key: :background_color,
2558 suggestions: ["#2C3645"]
2561 key: :content_background_color,
2563 suggestions: ["#1B2635"]
2568 suggestions: ["#d8a070"]
2573 suggestions: ["#b9b9ba"]
2576 key: :text_muted_color,
2578 suggestions: ["#b9b9ba"]
2586 key: Pleroma.Emails.NewUsersDigestEmail,
2588 description: "New users admin email digest",
2593 description: "Enables new users admin digest email when `true`"
2602 description: "Configure OAuth 2 provider capabilities",
2605 key: :token_expires_in,
2607 description: "The lifetime in seconds of the access token",
2611 key: :issue_new_refresh_token,
2614 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2617 key: :clean_expired_tokens,
2619 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2629 key: :shortcode_globs,
2630 type: {:list, :string},
2631 description: "Location of custom emoji files. * can be used as a wildcard.",
2632 suggestions: ["/emoji/custom/**/*.png"]
2635 key: :pack_extensions,
2636 type: {:list, :string},
2638 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2639 suggestions: [".png", ".gif"]
2643 type: {:keyword, {:list, :string}},
2645 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2646 " and the value is the location or array of locations. * can be used as a wildcard.",
2648 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2652 key: :default_manifest,
2655 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2656 " Currently only one manifest can be added (no arrays).",
2657 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2660 key: :shared_pack_cache_seconds_per_file,
2661 label: "Shared pack cache s/file",
2664 "When an emoji pack is shared, the archive is created and cached in memory" <>
2665 " for this amount of seconds multiplied by the number of files.",
2675 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2679 type: [:tuple, {:list, :tuple}],
2680 description: "For the search requests (account & status search etc.)",
2681 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2685 type: [:tuple, {:list, :tuple}],
2686 description: "For requests to timelines (each timeline has it's own limiter)",
2687 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2690 key: :app_account_creation,
2691 type: [:tuple, {:list, :tuple}],
2692 description: "For registering user accounts from the same IP address",
2693 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2696 key: :relations_actions,
2697 type: [:tuple, {:list, :tuple}],
2698 description: "For actions on relationships with all users (follow, unfollow)",
2699 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2702 key: :relation_id_action,
2703 label: "Relation ID action",
2704 type: [:tuple, {:list, :tuple}],
2705 description: "For actions on relation with a specific user (follow, unfollow)",
2706 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2709 key: :statuses_actions,
2710 type: [:tuple, {:list, :tuple}],
2712 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2713 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2716 key: :status_id_action,
2717 label: "Status ID action",
2718 type: [:tuple, {:list, :tuple}],
2720 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2721 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2724 key: :authentication,
2725 type: [:tuple, {:list, :tuple}],
2726 description: "For authentication create / password check / user existence check requests",
2727 suggestions: [{60_000, 15}]
2736 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2737 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2742 description: "Enables SSH"
2747 description: "Dir with SSH keys",
2748 suggestions: ["/some/path/ssh_keys"]
2753 description: "Handler module",
2754 suggestions: ["Pleroma.BBS.Handler"]
2759 description: "Port to connect",
2760 suggestions: [10_022]
2763 key: :password_authenticator,
2765 description: "Authenticator module",
2766 suggestions: ["Pleroma.BBS.Authenticator"]
2772 label: "Mime Types",
2774 description: "Mime Types settings",
2781 "application/xml" => ["xml"],
2782 "application/xrd+xml" => ["xrd+xml"],
2783 "application/jrd+json" => ["jrd+json"],
2784 "application/activity+json" => ["activity+json"],
2785 "application/ld+json" => ["activity+json"]
2790 key: "application/xml",
2791 type: {:list, :string},
2792 suggestions: ["xml"]
2795 key: "application/xrd+xml",
2796 type: {:list, :string},
2797 suggestions: ["xrd+xml"]
2800 key: "application/jrd+json",
2801 type: {:list, :string},
2802 suggestions: ["jrd+json"]
2805 key: "application/activity+json",
2806 type: {:list, :string},
2807 suggestions: ["activity+json"]
2810 key: "application/ld+json",
2811 type: {:list, :string},
2812 suggestions: ["activity+json"]
2822 description: "Pleroma chat settings",
2835 description: "HTTP settings",
2840 type: [:string, :tuple],
2841 description: "Proxy URL",
2842 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2845 key: :send_user_agent,
2850 type: [:string, :atom],
2852 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2853 suggestions: ["Pleroma", :default]
2858 description: "Adapter specific options",
2864 label: "SSL Options",
2865 description: "SSL options for HTTP adapter",
2869 type: {:list, :atom},
2870 description: "List of TLS version to use",
2871 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2882 label: "Markup Settings",
2886 key: :allow_inline_images,
2890 key: :allow_headings,
2903 type: {:list, :module},
2905 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2906 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2916 key: :deny_follow_blocked,
2923 key: :mrf_normalize_markup,
2925 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
2926 label: "MRF Normalize Markup",
2927 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2933 suggestions: [Pleroma.HTML.Scrubber.Default]
2943 key: :restricted_nicknames,
2944 type: {:list, :string},
2963 "ostatus_subscribe",
2982 label: "CORS plug config",
2988 suggestions: [86_400]
2992 type: {:list, :string},
2993 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2997 type: {:list, :string},
3000 "X-RateLimit-Reset",
3001 "X-RateLimit-Limit",
3002 "X-RateLimit-Remaining",
3013 type: {:list, :string},
3014 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3020 key: Pleroma.Plugs.RemoteIp,
3023 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3024 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3030 description: "Enable/disable the plug. Default: disabled."
3034 type: {:list, :string},
3036 "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]`."
3040 type: {:list, :string},
3042 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3046 type: {:list, :string},
3048 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3054 key: :web_cache_ttl,
3055 label: "Web cache TTL",
3058 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3064 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3065 suggestions: [30_000, nil]
3068 key: :activity_pub_question,
3070 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3071 suggestions: [30_000]
3081 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3086 description: "Enables the rendering of static HTML. Default: disabled."
3094 description: "Configure feed rendering",
3099 description: "Configure title rendering",
3104 description: "Maximum number of characters before truncating title",
3110 description: "Replacement which will be used after truncating string",
3111 suggestions: ["..."]
3119 key: :mrf_object_age,
3121 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3122 label: "MRF Object Age",
3125 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3130 description: "Required age (in seconds) of a post before actions are taken.",
3131 suggestions: [172_800]
3135 type: {:list, :atom},
3137 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3138 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3139 "`:reject` rejects the message entirely",
3140 suggestions: [:delist, :strip_followers, :reject]
3148 description: "Custom Runtime Modules",
3153 description: "A path to custom Elixir modules (such as MRF policies)."
3161 description: "Settings for notifications streamer",
3166 description: "Number of workers to send notifications",
3170 key: :overflow_workers,
3172 description: "Maximum number of workers created if pool is empty",
3179 key: :connections_pool,
3181 description: "Advanced settings for `gun` connections pool",
3184 key: :connection_acquisition_wait,
3187 "Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries. Default: 250ms.",
3191 key: :connection_acquisition_retries,
3194 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3198 key: :max_connections,
3200 description: "Maximum number of connections in the pool. Default: 250 connections.",
3204 key: :await_up_timeout,
3206 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3210 key: :reclaim_multiplier,
3213 "Multiplier for the number of idle connection to be reclaimed if the pool is full. For example if the pool maxes out at 250 connections and this setting is set to 0.3, the pool will reclaim at most 75 idle connections if it's overloaded. Default: 0.1",
3222 description: "Advanced settings for `gun` workers pools",
3224 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3228 description: "Settings for #{pool_name} pool.",
3233 description: "Maximum number of concurrent requests in the pool.",
3240 "Maximum number of requests waiting for other requests to finish. After this number is reached, the pool will start returning errrors when a new request is made",
3249 key: :hackney_pools,
3251 description: "Advanced settings for `hackney` connections pools",
3256 description: "Settings for federation pool.",
3259 key: :max_connections,
3261 description: "Number workers in the pool.",
3267 description: "Timeout while `hackney` will wait for response.",
3268 suggestions: [150_000]
3275 description: "Settings for media pool.",
3278 key: :max_connections,
3280 description: "Number workers in the pool.",
3286 description: "Timeout while `hackney` will wait for response.",
3287 suggestions: [150_000]
3294 description: "Settings for upload pool.",
3297 key: :max_connections,
3299 description: "Number workers in the pool.",
3305 description: "Timeout while `hackney` will wait for response.",
3306 suggestions: [300_000]
3314 key: :restrict_unauthenticated,
3317 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3322 description: "Settings for public and federated timelines.",
3327 description: "Disallow view public timeline."
3332 description: "Disallow view federated timeline."
3339 description: "Settings for user profiles.",
3344 description: "Disallow view local user profiles."
3349 description: "Disallow view remote user profiles."
3356 description: "Settings for statuses.",
3361 description: "Disallow view local statuses."
3366 description: "Disallow view remote statuses."
3374 key: Pleroma.Web.ApiSpec.CastAndValidate,
3381 "Enables strict input validation (useful in development, not recommended in production)"
3387 key: :instances_favicons,
3389 description: "Control favicons for instances",
3394 description: "Allow/disallow displaying and getting instances favicons"
3402 descriptions: "S3 service related settings",
3405 key: :access_key_id,
3407 description: "S3 access key ID",
3408 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3411 key: :secret_access_key,
3413 description: "Secret access key",
3414 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3419 description: "S3 host",
3420 suggestions: ["s3.eu-central-1.amazonaws.com"]