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",
1071 description: "Configure the Slack incoming webhook",
1072 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1078 key: :frontend_configurations,
1081 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1082 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1083 "add your own configuration your settings all fields must be complete.",
1087 label: "Pleroma FE",
1089 description: "Settings for Pleroma FE",
1092 alwaysShowSubjectInput: true,
1093 background: "/static/aurora_borealis.jpg",
1094 collapseMessageWithSubject: false,
1097 hideFilteredStatuses: false,
1098 hideMutedPosts: false,
1099 hidePostStats: false,
1100 hideSitename: false,
1101 hideUserStats: false,
1102 loginMethod: "password",
1103 logo: "/static/logo.png",
1106 minimalScopesMode: false,
1107 noAttachmentLinks: false,
1108 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1109 postContentType: "text/plain",
1110 redirectRootLogin: "/main/friends",
1111 redirectRootNoLogin: "/main/all",
1113 sidebarRight: false,
1114 showFeaturesPanel: true,
1115 showInstanceSpecificPanel: false,
1116 subjectLineBehavior: "email",
1117 theme: "pleroma-dark",
1118 webPushNotifications: false
1123 key: :alwaysShowSubjectInput,
1124 label: "Always show subject input",
1126 description: "When disabled, auto-hide the subject field if it's empty"
1132 "URL of the background, unless viewing a user profile with a background that is set",
1133 suggestions: ["/images/city.jpg"]
1136 key: :collapseMessageWithSubject,
1137 label: "Collapse message with subject",
1140 "When a message has a subject (aka Content Warning), collapse it by default"
1144 label: "PleromaFE Chat",
1146 description: "Disables PleromaFE Chat component"
1152 description: "Enables green text on lines prefixed with the > character"
1155 key: :hideFilteredStatuses,
1156 label: "Hide Filtered Statuses",
1158 description: "Hides filtered statuses from timelines"
1161 key: :hideMutedPosts,
1162 label: "Hide Muted Posts",
1164 description: "Hides muted statuses from timelines"
1167 key: :hidePostStats,
1168 label: "Hide post stats",
1170 description: "Hide notices statistics (repeats, favorites, ...)"
1174 label: "Hide Sitename",
1176 description: "Hides instance name from PleromaFE banner"
1179 key: :hideUserStats,
1180 label: "Hide user stats",
1183 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1188 description: "URL of the logo, defaults to Pleroma's logo",
1189 suggestions: ["/static/logo.png"]
1193 label: "Logo margin",
1196 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1197 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1198 suggestions: [".1em"]
1205 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1206 "If you want a colorful logo you must disable logoMask."
1209 key: :minimalScopesMode,
1210 label: "Minimal scopes mode",
1213 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1214 "Also prevents replying to a DM with a public post from PleromaFE."
1217 key: :nsfwCensorImage,
1218 label: "NSFW Censor Image",
1221 "URL of the image to use for hiding NSFW media attachments in the timeline",
1222 suggestions: ["/static/img/nsfw.74818f9.png"]
1225 key: :postContentType,
1226 label: "Post Content Type",
1227 type: {:dropdown, :atom},
1228 description: "Default post formatting option",
1229 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1232 key: :redirectRootNoLogin,
1233 label: "Redirect root no login",
1236 "Relative URL which indicates where to redirect when a user isn't logged in",
1237 suggestions: ["/main/all"]
1240 key: :redirectRootLogin,
1241 label: "Redirect root login",
1244 "Relative URL which indicates where to redirect when a user is logged in",
1245 suggestions: ["/main/friends"]
1249 label: "Scope copy",
1251 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1255 label: "Sidebar on Right",
1257 description: "Change alignment of sidebar and panels to the right"
1260 key: :showFeaturesPanel,
1261 label: "Show instance features panel",
1264 "Enables panel displaying functionality of the instance on the About page"
1267 key: :showInstanceSpecificPanel,
1268 label: "Show instance specific panel",
1270 description: "Whether to show the instance's custom panel"
1273 key: :subjectLineBehavior,
1274 label: "Subject line behavior",
1276 description: "Allows changing the default behaviour of subject lines in replies.
1277 `email`: copy and preprend re:, as in email,
1278 `masto`: copy verbatim, as in Mastodon,
1279 `noop`: don't copy the subject.",
1280 suggestions: ["email", "masto", "noop"]
1285 description: "Which theme to use. Available themes are defined in styles.json",
1286 suggestions: ["pleroma-dark"]
1294 description: "Settings for Masto FE",
1297 showInstanceSpecificPanel: true
1302 key: :showInstanceSpecificPanel,
1303 label: "Show instance specific panel",
1305 description: "Whenether to show the instance's specific panel"
1316 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1320 type: {:keyword, :map},
1322 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1325 url: "/images/pleroma-fox-tan-smol.png",
1326 mime_type: "image/png"
1328 pleroma_fox_tan_shy: %{
1329 url: "/images/pleroma-fox-tan-shy.png",
1330 mime_type: "image/png"
1335 key: :default_mascot,
1338 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1344 key: :default_user_avatar,
1346 description: "URL of the default user avatar",
1347 suggestions: ["/images/avi.png"]
1356 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1360 type: {:list, :map},
1361 description: "Describe the icons of the app",
1364 src: "/static/logo.png"
1367 src: "/static/icon.png",
1371 src: "/static/icon.ico",
1372 sizes: "72x72 96x96 128x128 256x256"
1379 description: "Describe the theme color of the app",
1380 suggestions: ["#282c37", "mediumpurple"]
1383 key: :background_color,
1385 description: "Describe the background color of the app",
1386 suggestions: ["#191b22", "aliceblue"]
1396 description: "General MRF settings",
1400 type: [:module, {:list, :module}],
1402 "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.",
1403 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1407 label: "MRF transparency",
1410 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1413 key: :transparency_exclusions,
1414 label: "MRF transparency exclusions",
1415 type: {:list, :string},
1417 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1428 label: "MRF Simple",
1430 description: "Simple ingress policies",
1433 key: :media_removal,
1434 type: {:list, :string},
1435 description: "List of instances to strip media attachments from",
1436 suggestions: ["example.com", "*.example.com"]
1440 label: "Media NSFW",
1441 type: {:list, :string},
1442 description: "List of instances to tag all media as NSFW (sensitive) from",
1443 suggestions: ["example.com", "*.example.com"]
1446 key: :federated_timeline_removal,
1447 type: {:list, :string},
1449 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1450 suggestions: ["example.com", "*.example.com"]
1454 type: {:list, :string},
1455 description: "List of instances to reject activities from (except deletes)",
1456 suggestions: ["example.com", "*.example.com"]
1460 type: {:list, :string},
1461 description: "List of instances to only accept activities from (except deletes)",
1462 suggestions: ["example.com", "*.example.com"]
1465 key: :report_removal,
1466 type: {:list, :string},
1467 description: "List of instances to reject reports from",
1468 suggestions: ["example.com", "*.example.com"]
1471 key: :avatar_removal,
1472 type: {:list, :string},
1473 description: "List of instances to strip avatars from",
1474 suggestions: ["example.com", "*.example.com"]
1477 key: :banner_removal,
1478 type: {:list, :string},
1479 description: "List of instances to strip banners from",
1480 suggestions: ["example.com", "*.example.com"]
1483 key: :reject_deletes,
1484 type: {:list, :string},
1485 description: "List of instances to reject deletions from",
1486 suggestions: ["example.com", "*.example.com"]
1492 key: :mrf_activity_expiration,
1494 label: "MRF Activity Expiration Policy",
1496 description: "Adds automatic expiration to all local activities",
1501 description: "Default global expiration time for all local activities (in days)",
1502 suggestions: [90, 365]
1510 label: "MRF Subchain",
1513 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1514 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1519 description: "Matches a series of regular expressions against the actor field",
1522 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1530 key: :mrf_rejectnonpublic,
1532 description: "RejectNonPublic drops posts with non-public visibility settings.",
1533 label: "MRF Reject Non Public",
1537 key: :allow_followersonly,
1538 label: "Allow followers-only",
1540 description: "Whether to allow followers-only posts"
1545 description: "Whether to allow direct messages"
1551 key: :mrf_hellthread,
1553 label: "MRF Hellthread",
1555 description: "Block messages with excessive user mentions",
1558 key: :delist_threshold,
1561 "Number of mentioned users after which the message gets removed from timelines and" <>
1562 "disables notifications. Set to 0 to disable.",
1566 key: :reject_threshold,
1569 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1578 label: "MRF Keyword",
1580 description: "Reject or Word-Replace messages with a keyword or regex",
1584 type: [:string, :regex],
1586 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1587 suggestions: ["foo", ~r/foo/iu]
1590 key: :federated_timeline_removal,
1591 type: [:string, :regex],
1593 "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.",
1594 suggestions: ["foo", ~r/foo/iu]
1598 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1600 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1601 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1609 label: "MRF Mention",
1611 description: "Block messages which mention a specific user",
1615 type: {:list, :string},
1616 description: "A list of actors for which any post mentioning them will be dropped",
1617 suggestions: ["actor1", "actor2"]
1623 key: :mrf_vocabulary,
1625 label: "MRF Vocabulary",
1627 description: "Filter messages which belong to certain activity vocabularies",
1631 type: {:list, :string},
1633 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1634 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1638 type: {:list, :string},
1640 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1641 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1647 # key: :mrf_user_allowlist,
1650 # "The keys in this section are the domain names that the policy should apply to." <>
1651 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1653 # %{"example.org" => ["https://example.org/users/admin"]}
1661 description: "Media proxy",
1666 description: "Enables proxying of remote media to the instance's proxy"
1673 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1674 suggestions: ["https://example.com"]
1682 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1688 description: "Enables invalidate media cache"
1693 description: "Module which will be used to cache purge.",
1695 Pleroma.Web.MediaProxy.Invalidation.Script,
1696 Pleroma.Web.MediaProxy.Invalidation.Http
1703 label: "Proxy Options",
1705 description: "Options for Pleroma.ReverseProxy",
1707 redirect_on_failure: false,
1708 max_body_length: 25 * 1_048_576,
1710 follow_redirect: true,
1716 key: :redirect_on_failure,
1719 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1720 "Any error during body processing will not be redirected as the response is chunked."
1723 key: :max_body_length,
1726 "Limits the content length to be approximately the " <>
1727 "specified length. It is validated with the `content-length` header and also verified when proxying."
1733 description: "HTTP options",
1738 description: "Adapter specific options",
1743 label: "SSL Options",
1744 description: "SSL options for HTTP adapter",
1748 type: {:list, :atom},
1749 description: "List of TLS version to use",
1750 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1759 type: [:string, :tuple],
1760 description: "Proxy URL",
1761 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1769 type: {:list, :string},
1770 description: "List of domains to bypass the mediaproxy",
1771 suggestions: ["example.com"]
1777 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1779 description: "HTTP invalidate settings",
1784 description: "HTTP method of request. Default: :purge"
1788 type: {:list, :tuple},
1789 description: "HTTP headers of request.",
1790 suggestions: [{"x-refresh", 1}]
1795 description: "Request options.",
1796 suggestions: [params: %{ts: "xxx"}]
1802 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1804 description: "Script invalidate settings",
1809 description: "Path to shell script. Which will run purge cache.",
1810 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1818 description: "Gopher settings",
1823 description: "Enables the gopher interface"
1829 description: "IP address to bind to",
1830 suggestions: [{0, 0, 0, 0}]
1835 description: "Port to bind to",
1841 description: "Port advertised in URLs (optional, defaults to port)",
1849 label: "ActivityPub",
1851 description: "ActivityPub-related settings",
1854 key: :unfollow_blocked,
1856 description: "Whether blocks result in people getting unfollowed"
1859 key: :outgoing_blocks,
1861 description: "Whether to federate blocks to other instances"
1864 key: :sign_object_fetches,
1866 description: "Sign object fetches with HTTP signatures"
1869 key: :note_replies_output_limit,
1872 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1875 key: :follow_handshake_timeout,
1877 description: "Following handshake timeout",
1884 key: :http_security,
1885 label: "HTTP security",
1887 description: "HTTP security settings",
1892 description: "Whether the managed content security policy is enabled"
1898 description: "Whether to additionally send a Strict-Transport-Security header"
1902 label: "STS max age",
1904 description: "The maximum age for the Strict-Transport-Security header if sent",
1905 suggestions: [31_536_000]
1909 label: "CT max age",
1911 description: "The maximum age for the Expect-CT header if sent",
1912 suggestions: [2_592_000]
1915 key: :referrer_policy,
1917 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1918 suggestions: ["same-origin", "no-referrer"]
1922 label: "Report URI",
1924 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1925 suggestions: ["https://example.com/report-uri"]
1930 group: :web_push_encryption,
1931 key: :vapid_details,
1932 label: "Vapid Details",
1935 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1941 "A mailto link for the administrative contact." <>
1942 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1943 suggestions: ["mailto:moderators@pleroma.com"]
1948 description: "VAPID public key",
1949 suggestions: ["Public key"]
1954 description: "VAPID private key",
1955 suggestions: ["Private key"]
1961 key: Pleroma.Captcha,
1963 description: "Captcha-related settings",
1968 description: "Whether the captcha should be shown on registration"
1973 description: "The method/service to use for captcha",
1974 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1977 key: :seconds_valid,
1979 description: "The time in seconds for which the captcha is valid",
1986 key: Pleroma.Captcha.Kocaptcha,
1989 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1990 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1995 description: "The kocaptcha endpoint to use",
1996 suggestions: ["https://captcha.kotobank.ch"]
2002 label: "Pleroma Admin Token",
2005 "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",
2010 description: "Admin token",
2011 suggestions: ["We recommend a secure random string or UUID"]
2020 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2022 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2023 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2024 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2025 (see https://github.com/sorentwo/oban/issues/52).
2030 type: {:dropdown, :atom},
2031 description: "Logs verbose mode",
2032 suggestions: [false, :error, :warn, :info, :debug]
2036 type: {:keyword, :integer},
2038 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2040 activity_expiration: 10,
2041 attachments_cleanup: 5,
2043 federator_incoming: 50,
2044 federator_outgoing: 50,
2046 scheduled_activities: 10,
2052 key: :activity_expiration,
2054 description: "Activity expiration queue",
2058 key: :attachments_cleanup,
2060 description: "Attachment deletion queue",
2066 description: "Background queue",
2070 key: :federator_incoming,
2072 description: "Incoming federation queue",
2076 key: :federator_outgoing,
2078 description: "Outgoing federation queue",
2084 description: "Email sender queue, see Pleroma.Emails.Mailer",
2088 key: :scheduled_activities,
2090 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2094 key: :transmogrifier,
2096 description: "Transmogrifier queue",
2102 description: "Web push notifications queue",
2109 type: {:list, :tuple},
2110 description: "Settings for cron background jobs",
2112 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2113 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2114 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2115 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2116 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2125 description: "Includes custom worker options not interpretable directly by `Oban`",
2129 type: {:keyword, :integer},
2130 description: "Max retry attempts for failed jobs, per `Oban` queue",
2132 federator_incoming: 5,
2133 federator_outgoing: 5
2140 key: Pleroma.Web.Metadata,
2142 description: "Metadata-related settings",
2146 type: {:list, :module},
2147 description: "List of metadata providers to enable",
2149 Pleroma.Web.Metadata.Providers.OpenGraph,
2150 Pleroma.Web.Metadata.Providers.TwitterCard,
2151 Pleroma.Web.Metadata.Providers.RelMe,
2152 Pleroma.Web.Metadata.Providers.Feed
2157 label: "Unfurl NSFW",
2159 description: "When enabled NSFW attachments will be shown in previews"
2168 "If enabled the instance will parse metadata from attached links to generate link previews",
2173 description: "Enables RichMedia parsing of URLs"
2177 type: {:list, :string},
2178 description: "List of hosts which will be ignored by the metadata parser",
2179 suggestions: ["accounts.google.com", "xss.website"]
2183 label: "Ignore TLD",
2184 type: {:list, :string},
2185 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2186 suggestions: ["local", "localdomain", "lan"]
2190 type: {:list, :module},
2192 "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.",
2194 Pleroma.Web.RichMedia.Parsers.OEmbed,
2195 Pleroma.Web.RichMedia.Parsers.TwitterCard
2200 label: "TTL setters",
2201 type: {:list, :module},
2203 "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.",
2205 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2211 group: :auto_linker,
2213 label: "Auto Linker",
2215 description: "Configuration for the auto_linker library",
2219 type: [:string, false],
2220 description: "Specify the class to be added to the generated link. Disable to clear.",
2221 suggestions: ["auto-linker", false]
2225 type: [:string, false],
2226 description: "Override the rel attribute. Disable to clear.",
2227 suggestions: ["ugc", "noopener noreferrer", false]
2232 description: "Link URLs will open in new window/tab"
2236 type: [:integer, false],
2238 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2239 suggestions: [15, false]
2244 description: "Strip the scheme prefix"
2249 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2255 key: Pleroma.ScheduledActivity,
2257 description: "Scheduled activities settings",
2260 key: :daily_user_limit,
2263 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2267 key: :total_user_limit,
2270 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2276 description: "Whether scheduled activities are sent to the job queue to be executed"
2282 key: Pleroma.ActivityExpiration,
2284 description: "Expired activity settings",
2289 description: "Whether expired activities will be sent to the job queue to be deleted"
2295 label: "Pleroma Authenticator",
2297 description: "Authenticator",
2300 key: Pleroma.Web.Auth.Authenticator,
2302 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2312 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2313 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2314 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2315 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2320 description: "Enables LDAP authentication"
2325 description: "LDAP server hostname",
2326 suggestions: ["localhosts"]
2331 description: "LDAP port, e.g. 389 or 636",
2332 suggestions: [389, 636]
2338 description: "Enable to use SSL, usually implies the port 636"
2342 label: "SSL options",
2344 description: "Additional SSL options",
2345 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2350 description: "Path to file with PEM encoded cacerts",
2351 suggestions: ["path/to/file/with/PEM/cacerts"]
2356 description: "Type of cert verification",
2357 suggestions: [:verify_peer]
2365 description: "Enable to use STARTTLS, usually implies the port 389"
2369 label: "TLS options",
2371 description: "Additional TLS options",
2372 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2377 description: "Path to file with PEM encoded cacerts",
2378 suggestions: ["path/to/file/with/PEM/cacerts"]
2383 description: "Type of cert verification",
2384 suggestions: [:verify_peer]
2391 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2392 suggestions: ["dc=example,dc=com"]
2399 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2408 description: "Authentication / authorization settings",
2411 key: :enforce_oauth_admin_scope_usage,
2412 label: "Enforce OAuth admin scope usage",
2415 "OAuth admin scope requirement toggle. " <>
2416 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2417 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2418 "`is_admin` user flag grants access to admin-specific actions."
2421 key: :auth_template,
2424 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2425 suggestions: ["show.html"]
2428 key: :oauth_consumer_template,
2429 label: "OAuth consumer template",
2432 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2433 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2434 suggestions: ["consumer.html"]
2437 key: :oauth_consumer_strategies,
2438 label: "OAuth consumer strategies",
2439 type: {:list, :string},
2441 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2442 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2443 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2444 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2450 key: :email_notifications,
2452 description: "Email notifications settings",
2458 "emails of \"what you've missed\" for users who have been inactive for a while",
2462 schedule: "0 0 * * 0",
2464 inactivity_threshold: 7
2472 description: "Globally enable or disable digest emails"
2478 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2479 suggestions: ["0 0 * * 0"]
2484 description: "Minimum interval between digest emails to one user",
2488 key: :inactivity_threshold,
2490 description: "Minimum user inactivity threshold",
2499 key: Pleroma.Emails.UserEmail,
2501 description: "Email template settings",
2506 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2507 suggestions: ["some/path/logo.png"]
2512 description: "a map with color settings for email templates.",
2515 link_color: "#d8a070",
2516 background_color: "#2C3645",
2517 content_background_color: "#1B2635",
2518 header_color: "#d8a070",
2519 text_color: "#b9b9ba",
2520 text_muted_color: "#b9b9ba"
2527 suggestions: ["#d8a070"]
2530 key: :background_color,
2532 suggestions: ["#2C3645"]
2535 key: :content_background_color,
2537 suggestions: ["#1B2635"]
2542 suggestions: ["#d8a070"]
2547 suggestions: ["#b9b9ba"]
2550 key: :text_muted_color,
2552 suggestions: ["#b9b9ba"]
2560 key: Pleroma.Emails.NewUsersDigestEmail,
2562 description: "New users admin email digest",
2567 description: "Enables new users admin digest email when `true`"
2576 description: "Configure OAuth 2 provider capabilities",
2579 key: :token_expires_in,
2581 description: "The lifetime in seconds of the access token",
2585 key: :issue_new_refresh_token,
2588 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2591 key: :clean_expired_tokens,
2593 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2603 key: :shortcode_globs,
2604 type: {:list, :string},
2605 description: "Location of custom emoji files. * can be used as a wildcard.",
2606 suggestions: ["/emoji/custom/**/*.png"]
2609 key: :pack_extensions,
2610 type: {:list, :string},
2612 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2613 suggestions: [".png", ".gif"]
2617 type: {:keyword, :string, {:list, :string}},
2619 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2620 " and the value is the location or array of locations. * can be used as a wildcard.",
2622 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2626 key: :default_manifest,
2629 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2630 " Currently only one manifest can be added (no arrays).",
2631 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2634 key: :shared_pack_cache_seconds_per_file,
2635 label: "Shared pack cache s/file",
2638 "When an emoji pack is shared, the archive is created and cached in memory" <>
2639 " for this amount of seconds multiplied by the number of files.",
2649 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2653 type: [:tuple, {:list, :tuple}],
2654 description: "For the search requests (account & status search etc.)",
2655 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2659 type: [:tuple, {:list, :tuple}],
2660 description: "For requests to timelines (each timeline has it's own limiter)",
2661 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2664 key: :app_account_creation,
2665 type: [:tuple, {:list, :tuple}],
2666 description: "For registering user accounts from the same IP address",
2667 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2670 key: :relations_actions,
2671 type: [:tuple, {:list, :tuple}],
2672 description: "For actions on relationships with all users (follow, unfollow)",
2673 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2676 key: :relation_id_action,
2677 label: "Relation ID action",
2678 type: [:tuple, {:list, :tuple}],
2679 description: "For actions on relation with a specific user (follow, unfollow)",
2680 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2683 key: :statuses_actions,
2684 type: [:tuple, {:list, :tuple}],
2686 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2687 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2690 key: :status_id_action,
2691 label: "Status ID action",
2692 type: [:tuple, {:list, :tuple}],
2694 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2695 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2698 key: :authentication,
2699 type: [:tuple, {:list, :tuple}],
2700 description: "For authentication create / password check / user existence check requests",
2701 suggestions: [{60_000, 15}]
2710 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2711 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2716 description: "Enables SSH"
2721 description: "Dir with SSH keys",
2722 suggestions: ["/some/path/ssh_keys"]
2727 description: "Handler module",
2728 suggestions: ["Pleroma.BBS.Handler"]
2733 description: "Port to connect",
2734 suggestions: [10_022]
2737 key: :password_authenticator,
2739 description: "Authenticator module",
2740 suggestions: ["Pleroma.BBS.Authenticator"]
2746 label: "Mime Types",
2748 description: "Mime Types settings",
2755 "application/xml" => ["xml"],
2756 "application/xrd+xml" => ["xrd+xml"],
2757 "application/jrd+json" => ["jrd+json"],
2758 "application/activity+json" => ["activity+json"],
2759 "application/ld+json" => ["activity+json"]
2764 key: "application/xml",
2765 type: {:list, :string},
2766 suggestions: ["xml"]
2769 key: "application/xrd+xml",
2770 type: {:list, :string},
2771 suggestions: ["xrd+xml"]
2774 key: "application/jrd+json",
2775 type: {:list, :string},
2776 suggestions: ["jrd+json"]
2779 key: "application/activity+json",
2780 type: {:list, :string},
2781 suggestions: ["activity+json"]
2784 key: "application/ld+json",
2785 type: {:list, :string},
2786 suggestions: ["activity+json"]
2796 description: "Pleroma chat settings",
2809 description: "HTTP settings",
2814 type: [:string, :tuple],
2815 description: "Proxy URL",
2816 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2819 key: :send_user_agent,
2824 type: [:string, :atom],
2826 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2827 suggestions: ["Pleroma", :default]
2832 description: "Adapter specific options",
2838 label: "SSL Options",
2839 description: "SSL options for HTTP adapter",
2843 type: {:list, :atom},
2844 description: "List of TLS version to use",
2845 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2856 label: "Markup Settings",
2860 key: :allow_inline_images,
2864 key: :allow_headings,
2877 type: {:list, :module},
2879 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2880 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2890 key: :deny_follow_blocked,
2898 key: :mrf_normalize_markup,
2899 label: "MRF Normalize Markup",
2900 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2906 suggestions: [Pleroma.HTML.Scrubber.Default]
2916 key: :restricted_nicknames,
2917 type: {:list, :string},
2936 "ostatus_subscribe",
2955 label: "CORS plug config",
2961 suggestions: [86_400]
2965 type: {:list, :string},
2966 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2970 type: {:list, :string},
2973 "X-RateLimit-Reset",
2974 "X-RateLimit-Limit",
2975 "X-RateLimit-Remaining",
2986 type: {:list, :string},
2987 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2993 key: Pleroma.Plugs.RemoteIp,
2996 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2997 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3003 description: "Enable/disable the plug. Default: disabled."
3007 type: {:list, :string},
3009 "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]`."
3013 type: {:list, :string},
3015 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3019 type: {:list, :string},
3021 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3027 key: :web_cache_ttl,
3028 label: "Web cache TTL",
3031 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3037 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3038 suggestions: [30_000, nil]
3041 key: :activity_pub_question,
3043 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3044 suggestions: [30_000]
3054 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3059 description: "Enables the rendering of static HTML. Default: disabled."
3067 description: "Configure feed rendering",
3072 description: "Configure title rendering",
3077 description: "Maximum number of characters before truncating title",
3083 description: "Replacement which will be used after truncating string",
3084 suggestions: ["..."]
3092 key: :mrf_object_age,
3093 label: "MRF Object Age",
3097 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3102 description: "Required age (in seconds) of a post before actions are taken.",
3103 suggestions: [172_800]
3107 type: {:list, :atom},
3109 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3110 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3111 "`:reject` rejects the message entirely",
3112 suggestions: [:delist, :strip_followers, :reject]
3120 description: "Custom Runtime Modules",
3125 description: "A path to custom Elixir modules (such as MRF policies)."
3133 description: "Settings for notifications streamer",
3138 description: "Number of workers to send notifications",
3142 key: :overflow_workers,
3144 description: "Maximum number of workers created if pool is empty",
3151 key: :connections_pool,
3153 description: "Advanced settings for `gun` connections pool",
3156 key: :checkin_timeout,
3158 description: "Timeout to checkin connection from pool. Default: 250ms.",
3162 key: :max_connections,
3164 description: "Maximum number of connections in the pool. Default: 250 connections.",
3171 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3175 key: :retry_timeout,
3178 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3182 key: :await_up_timeout,
3184 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3193 description: "Advanced settings for `gun` workers pools",
3198 description: "Settings for federation pool.",
3203 description: "Number workers in the pool.",
3209 description: "Number of additional workers if pool is under load.",
3215 description: "Timeout while `gun` will wait for response.",
3216 suggestions: [150_000]
3223 description: "Settings for media pool.",
3228 description: "Number workers in the pool.",
3234 description: "Number of additional workers if pool is under load.",
3240 description: "Timeout while `gun` will wait for response.",
3241 suggestions: [150_000]
3248 description: "Settings for upload pool.",
3253 description: "Number workers in the pool.",
3259 description: "Number of additional workers if pool is under load.",
3265 description: "Timeout while `gun` will wait for response.",
3266 suggestions: [300_000]
3273 description: "Settings for default pool.",
3278 description: "Number workers in the pool.",
3284 description: "Number of additional workers if pool is under load.",
3290 description: "Timeout while `gun` will wait for response.",
3291 suggestions: [10_000]
3299 key: :hackney_pools,
3301 description: "Advanced settings for `hackney` connections pools",
3306 description: "Settings for federation pool.",
3309 key: :max_connections,
3311 description: "Number workers in the pool.",
3317 description: "Timeout while `hackney` will wait for response.",
3318 suggestions: [150_000]
3325 description: "Settings for media pool.",
3328 key: :max_connections,
3330 description: "Number workers in the pool.",
3336 description: "Timeout while `hackney` will wait for response.",
3337 suggestions: [150_000]
3344 description: "Settings for upload pool.",
3347 key: :max_connections,
3349 description: "Number workers in the pool.",
3355 description: "Timeout while `hackney` will wait for response.",
3356 suggestions: [300_000]
3364 key: :restrict_unauthenticated,
3367 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3372 description: "Settings for public and federated timelines.",
3377 description: "Disallow view public timeline."
3382 description: "Disallow view federated timeline."
3389 description: "Settings for user profiles.",
3394 description: "Disallow view local user profiles."
3399 description: "Disallow view remote user profiles."
3406 description: "Settings for statuses.",
3411 description: "Disallow view local statuses."
3416 description: "Disallow view remote statuses."
3424 key: Pleroma.Web.ApiSpec.CastAndValidate,
3431 "Enables strict input validation (useful in development, not recommended in production)"
3437 key: :instances_favicons,
3439 description: "Control favicons for instances",
3444 description: "Allow/disallow displaying and getting instances favicons"
3452 descriptions: "S3 service related settings",
3455 key: :access_key_id,
3457 description: "S3 access key ID",
3458 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3461 key: :secret_access_key,
3463 description: "Secret access key",
3464 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3469 description: "S3 host",
3470 suggestions: ["s3.eu-central-1.amazonaws.com"]