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 label: "MRF Simple",
1431 description: "Simple ingress policies",
1434 key: :media_removal,
1435 type: {:list, :string},
1436 description: "List of instances to strip media attachments from",
1437 suggestions: ["example.com", "*.example.com"]
1441 label: "Media NSFW",
1442 type: {:list, :string},
1443 description: "List of instances to tag all media as NSFW (sensitive) from",
1444 suggestions: ["example.com", "*.example.com"]
1447 key: :federated_timeline_removal,
1448 type: {:list, :string},
1450 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1451 suggestions: ["example.com", "*.example.com"]
1455 type: {:list, :string},
1456 description: "List of instances to reject activities from (except deletes)",
1457 suggestions: ["example.com", "*.example.com"]
1461 type: {:list, :string},
1462 description: "List of instances to only accept activities from (except deletes)",
1463 suggestions: ["example.com", "*.example.com"]
1466 key: :report_removal,
1467 type: {:list, :string},
1468 description: "List of instances to reject reports from",
1469 suggestions: ["example.com", "*.example.com"]
1472 key: :avatar_removal,
1473 type: {:list, :string},
1474 description: "List of instances to strip avatars from",
1475 suggestions: ["example.com", "*.example.com"]
1478 key: :banner_removal,
1479 type: {:list, :string},
1480 description: "List of instances to strip banners from",
1481 suggestions: ["example.com", "*.example.com"]
1484 key: :reject_deletes,
1485 type: {:list, :string},
1486 description: "List of instances to reject deletions from",
1487 suggestions: ["example.com", "*.example.com"]
1493 key: :mrf_activity_expiration,
1495 label: "MRF Activity Expiration Policy",
1497 description: "Adds automatic expiration to all local activities",
1502 description: "Default global expiration time for all local activities (in days)",
1503 suggestions: [90, 365]
1511 label: "MRF Subchain",
1514 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1515 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1519 type: {:map, {:list, :string}},
1520 description: "Matches a series of regular expressions against the actor field",
1523 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1531 key: :mrf_rejectnonpublic,
1533 description: "RejectNonPublic drops posts with non-public visibility settings.",
1534 label: "MRF Reject Non Public",
1538 key: :allow_followersonly,
1539 label: "Allow followers-only",
1541 description: "Whether to allow followers-only posts"
1546 description: "Whether to allow direct messages"
1552 key: :mrf_hellthread,
1554 label: "MRF Hellthread",
1556 description: "Block messages with excessive user mentions",
1559 key: :delist_threshold,
1562 "Number of mentioned users after which the message gets removed from timelines and" <>
1563 "disables notifications. Set to 0 to disable.",
1567 key: :reject_threshold,
1570 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1579 label: "MRF Keyword",
1581 description: "Reject or Word-Replace messages with a keyword or regex",
1585 type: {:list, :string},
1587 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1588 suggestions: ["foo", ~r/foo/iu]
1591 key: :federated_timeline_removal,
1592 type: {:list, :string},
1594 "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.",
1595 suggestions: ["foo", ~r/foo/iu]
1599 type: {:list, :tuple},
1601 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1602 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1610 label: "MRF Mention",
1612 description: "Block messages which mention a specific user",
1616 type: {:list, :string},
1617 description: "A list of actors for which any post mentioning them will be dropped",
1618 suggestions: ["actor1", "actor2"]
1624 key: :mrf_vocabulary,
1626 label: "MRF Vocabulary",
1628 description: "Filter messages which belong to certain activity vocabularies",
1632 type: {:list, :string},
1634 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1635 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1639 type: {:list, :string},
1641 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1642 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1648 # key: :mrf_user_allowlist,
1651 # "The keys in this section are the domain names that the policy should apply to." <>
1652 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1654 # %{"example.org" => ["https://example.org/users/admin"]}
1662 description: "Media proxy",
1667 description: "Enables proxying of remote media to the instance's proxy"
1674 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1675 suggestions: ["https://example.com"]
1683 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1689 description: "Enables invalidate media cache"
1694 description: "Module which will be used to cache purge.",
1696 Pleroma.Web.MediaProxy.Invalidation.Script,
1697 Pleroma.Web.MediaProxy.Invalidation.Http
1704 label: "Proxy Options",
1706 description: "Options for Pleroma.ReverseProxy",
1708 redirect_on_failure: false,
1709 max_body_length: 25 * 1_048_576,
1711 follow_redirect: true,
1717 key: :redirect_on_failure,
1720 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1721 "Any error during body processing will not be redirected as the response is chunked."
1724 key: :max_body_length,
1727 "Limits the content length to be approximately the " <>
1728 "specified length. It is validated with the `content-length` header and also verified when proxying."
1734 description: "HTTP options",
1739 description: "Adapter specific options",
1744 label: "SSL Options",
1745 description: "SSL options for HTTP adapter",
1749 type: {:list, :atom},
1750 description: "List of TLS version to use",
1751 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1760 type: [:string, :tuple],
1761 description: "Proxy URL",
1762 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1770 type: {:list, :string},
1771 description: "List of domains to bypass the mediaproxy",
1772 suggestions: ["example.com"]
1778 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1780 description: "HTTP invalidate settings",
1785 description: "HTTP method of request. Default: :purge"
1789 type: {:keyword, :string},
1790 description: "HTTP headers of request",
1791 suggestions: [{"x-refresh", 1}]
1796 description: "Request options",
1800 type: {:map, :string}
1808 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1810 description: "Script invalidate settings",
1815 description: "Path to shell script. Which will run purge cache.",
1816 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1824 description: "Gopher settings",
1829 description: "Enables the gopher interface"
1835 description: "IP address to bind to",
1836 suggestions: [{0, 0, 0, 0}]
1841 description: "Port to bind to",
1847 description: "Port advertised in URLs (optional, defaults to port)",
1855 label: "ActivityPub",
1857 description: "ActivityPub-related settings",
1860 key: :unfollow_blocked,
1862 description: "Whether blocks result in people getting unfollowed"
1865 key: :outgoing_blocks,
1867 description: "Whether to federate blocks to other instances"
1870 key: :sign_object_fetches,
1872 description: "Sign object fetches with HTTP signatures"
1875 key: :note_replies_output_limit,
1878 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1881 key: :follow_handshake_timeout,
1883 description: "Following handshake timeout",
1890 key: :http_security,
1891 label: "HTTP security",
1893 description: "HTTP security settings",
1898 description: "Whether the managed content security policy is enabled"
1904 description: "Whether to additionally send a Strict-Transport-Security header"
1908 label: "STS max age",
1910 description: "The maximum age for the Strict-Transport-Security header if sent",
1911 suggestions: [31_536_000]
1915 label: "CT max age",
1917 description: "The maximum age for the Expect-CT header if sent",
1918 suggestions: [2_592_000]
1921 key: :referrer_policy,
1923 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1924 suggestions: ["same-origin", "no-referrer"]
1928 label: "Report URI",
1930 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1931 suggestions: ["https://example.com/report-uri"]
1936 group: :web_push_encryption,
1937 key: :vapid_details,
1938 label: "Vapid Details",
1941 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1947 "A mailto link for the administrative contact." <>
1948 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1949 suggestions: ["mailto:moderators@pleroma.com"]
1954 description: "VAPID public key",
1955 suggestions: ["Public key"]
1960 description: "VAPID private key",
1961 suggestions: ["Private key"]
1967 key: Pleroma.Captcha,
1969 description: "Captcha-related settings",
1974 description: "Whether the captcha should be shown on registration"
1979 description: "The method/service to use for captcha",
1980 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1983 key: :seconds_valid,
1985 description: "The time in seconds for which the captcha is valid",
1992 key: Pleroma.Captcha.Kocaptcha,
1995 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1996 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2001 description: "The kocaptcha endpoint to use",
2002 suggestions: ["https://captcha.kotobank.ch"]
2008 label: "Pleroma Admin Token",
2011 "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",
2016 description: "Admin token",
2017 suggestions: ["We recommend a secure random string or UUID"]
2026 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2028 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2029 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2030 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2031 (see https://github.com/sorentwo/oban/issues/52).
2036 type: {:dropdown, :atom},
2037 description: "Logs verbose mode",
2038 suggestions: [false, :error, :warn, :info, :debug]
2042 type: {:keyword, :integer},
2044 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2046 activity_expiration: 10,
2047 attachments_cleanup: 5,
2049 federator_incoming: 50,
2050 federator_outgoing: 50,
2052 scheduled_activities: 10,
2058 key: :activity_expiration,
2060 description: "Activity expiration queue",
2064 key: :attachments_cleanup,
2066 description: "Attachment deletion queue",
2072 description: "Background queue",
2076 key: :federator_incoming,
2078 description: "Incoming federation queue",
2082 key: :federator_outgoing,
2084 description: "Outgoing federation queue",
2090 description: "Email sender queue, see Pleroma.Emails.Mailer",
2094 key: :scheduled_activities,
2096 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2100 key: :transmogrifier,
2102 description: "Transmogrifier queue",
2108 description: "Web push notifications queue",
2115 type: {:list, :tuple},
2116 description: "Settings for cron background jobs",
2118 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2119 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2120 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2121 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2122 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2131 description: "Includes custom worker options not interpretable directly by `Oban`",
2135 type: {:keyword, :integer},
2136 description: "Max retry attempts for failed jobs, per `Oban` queue",
2138 federator_incoming: 5,
2139 federator_outgoing: 5
2146 key: Pleroma.Web.Metadata,
2148 description: "Metadata-related settings",
2152 type: {:list, :module},
2153 description: "List of metadata providers to enable",
2155 Pleroma.Web.Metadata.Providers.OpenGraph,
2156 Pleroma.Web.Metadata.Providers.TwitterCard,
2157 Pleroma.Web.Metadata.Providers.RelMe,
2158 Pleroma.Web.Metadata.Providers.Feed
2163 label: "Unfurl NSFW",
2165 description: "When enabled NSFW attachments will be shown in previews"
2174 "If enabled the instance will parse metadata from attached links to generate link previews",
2179 description: "Enables RichMedia parsing of URLs"
2183 type: {:list, :string},
2184 description: "List of hosts which will be ignored by the metadata parser",
2185 suggestions: ["accounts.google.com", "xss.website"]
2189 label: "Ignore TLD",
2190 type: {:list, :string},
2191 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2192 suggestions: ["local", "localdomain", "lan"]
2196 type: {:list, :module},
2198 "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.",
2200 Pleroma.Web.RichMedia.Parsers.OEmbed,
2201 Pleroma.Web.RichMedia.Parsers.TwitterCard
2206 label: "TTL setters",
2207 type: {:list, :module},
2209 "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.",
2211 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2217 group: :auto_linker,
2219 label: "Auto Linker",
2221 description: "Configuration for the auto_linker library",
2225 type: [:string, false],
2226 description: "Specify the class to be added to the generated link. Disable to clear.",
2227 suggestions: ["auto-linker", false]
2231 type: [:string, false],
2232 description: "Override the rel attribute. Disable to clear.",
2233 suggestions: ["ugc", "noopener noreferrer", false]
2238 description: "Link URLs will open in new window/tab"
2242 type: [:integer, false],
2244 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2245 suggestions: [15, false]
2250 description: "Strip the scheme prefix"
2255 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2261 key: Pleroma.ScheduledActivity,
2263 description: "Scheduled activities settings",
2266 key: :daily_user_limit,
2269 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2273 key: :total_user_limit,
2276 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2282 description: "Whether scheduled activities are sent to the job queue to be executed"
2288 key: Pleroma.ActivityExpiration,
2290 description: "Expired activity settings",
2295 description: "Whether expired activities will be sent to the job queue to be deleted"
2301 label: "Pleroma Authenticator",
2303 description: "Authenticator",
2306 key: Pleroma.Web.Auth.Authenticator,
2308 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2318 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2319 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2320 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2321 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2326 description: "Enables LDAP authentication"
2331 description: "LDAP server hostname",
2332 suggestions: ["localhosts"]
2337 description: "LDAP port, e.g. 389 or 636",
2338 suggestions: [389, 636]
2344 description: "Enable to use SSL, usually implies the port 636"
2348 label: "SSL options",
2350 description: "Additional SSL options",
2351 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2356 description: "Path to file with PEM encoded cacerts",
2357 suggestions: ["path/to/file/with/PEM/cacerts"]
2362 description: "Type of cert verification",
2363 suggestions: [:verify_peer]
2371 description: "Enable to use STARTTLS, usually implies the port 389"
2375 label: "TLS options",
2377 description: "Additional TLS options",
2378 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2383 description: "Path to file with PEM encoded cacerts",
2384 suggestions: ["path/to/file/with/PEM/cacerts"]
2389 description: "Type of cert verification",
2390 suggestions: [:verify_peer]
2397 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2398 suggestions: ["dc=example,dc=com"]
2405 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2414 description: "Authentication / authorization settings",
2417 key: :enforce_oauth_admin_scope_usage,
2418 label: "Enforce OAuth admin scope usage",
2421 "OAuth admin scope requirement toggle. " <>
2422 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2423 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2424 "`is_admin` user flag grants access to admin-specific actions."
2427 key: :auth_template,
2430 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2431 suggestions: ["show.html"]
2434 key: :oauth_consumer_template,
2435 label: "OAuth consumer template",
2438 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2439 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2440 suggestions: ["consumer.html"]
2443 key: :oauth_consumer_strategies,
2444 label: "OAuth consumer strategies",
2445 type: {:list, :string},
2447 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2448 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2449 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2450 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2456 key: :email_notifications,
2458 description: "Email notifications settings",
2464 "emails of \"what you've missed\" for users who have been inactive for a while",
2468 schedule: "0 0 * * 0",
2470 inactivity_threshold: 7
2478 description: "Globally enable or disable digest emails"
2484 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2485 suggestions: ["0 0 * * 0"]
2490 description: "Minimum interval between digest emails to one user",
2494 key: :inactivity_threshold,
2496 description: "Minimum user inactivity threshold",
2505 key: Pleroma.Emails.UserEmail,
2507 description: "Email template settings",
2512 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2513 suggestions: ["some/path/logo.png"]
2518 description: "A map with color settings for email templates.",
2521 link_color: "#d8a070",
2522 background_color: "#2C3645",
2523 content_background_color: "#1B2635",
2524 header_color: "#d8a070",
2525 text_color: "#b9b9ba",
2526 text_muted_color: "#b9b9ba"
2533 suggestions: ["#d8a070"]
2536 key: :background_color,
2538 suggestions: ["#2C3645"]
2541 key: :content_background_color,
2543 suggestions: ["#1B2635"]
2548 suggestions: ["#d8a070"]
2553 suggestions: ["#b9b9ba"]
2556 key: :text_muted_color,
2558 suggestions: ["#b9b9ba"]
2566 key: Pleroma.Emails.NewUsersDigestEmail,
2568 description: "New users admin email digest",
2573 description: "Enables new users admin digest email when `true`"
2582 description: "Configure OAuth 2 provider capabilities",
2585 key: :token_expires_in,
2587 description: "The lifetime in seconds of the access token",
2591 key: :issue_new_refresh_token,
2594 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2597 key: :clean_expired_tokens,
2599 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2609 key: :shortcode_globs,
2610 type: {:list, :string},
2611 description: "Location of custom emoji files. * can be used as a wildcard.",
2612 suggestions: ["/emoji/custom/**/*.png"]
2615 key: :pack_extensions,
2616 type: {:list, :string},
2618 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2619 suggestions: [".png", ".gif"]
2623 type: {:keyword, {:list, :string}},
2625 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2626 " and the value is the location or array of locations. * can be used as a wildcard.",
2628 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2632 key: :default_manifest,
2635 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2636 " Currently only one manifest can be added (no arrays).",
2637 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2640 key: :shared_pack_cache_seconds_per_file,
2641 label: "Shared pack cache s/file",
2644 "When an emoji pack is shared, the archive is created and cached in memory" <>
2645 " for this amount of seconds multiplied by the number of files.",
2655 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2659 type: [:tuple, {:list, :tuple}],
2660 description: "For the search requests (account & status search etc.)",
2661 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2665 type: [:tuple, {:list, :tuple}],
2666 description: "For requests to timelines (each timeline has it's own limiter)",
2667 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2670 key: :app_account_creation,
2671 type: [:tuple, {:list, :tuple}],
2672 description: "For registering user accounts from the same IP address",
2673 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2676 key: :relations_actions,
2677 type: [:tuple, {:list, :tuple}],
2678 description: "For actions on relationships with all users (follow, unfollow)",
2679 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2682 key: :relation_id_action,
2683 label: "Relation ID action",
2684 type: [:tuple, {:list, :tuple}],
2685 description: "For actions on relation with a specific user (follow, unfollow)",
2686 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2689 key: :statuses_actions,
2690 type: [:tuple, {:list, :tuple}],
2692 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2693 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2696 key: :status_id_action,
2697 label: "Status ID action",
2698 type: [:tuple, {:list, :tuple}],
2700 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2701 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2704 key: :authentication,
2705 type: [:tuple, {:list, :tuple}],
2706 description: "For authentication create / password check / user existence check requests",
2707 suggestions: [{60_000, 15}]
2716 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2717 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2722 description: "Enables SSH"
2727 description: "Dir with SSH keys",
2728 suggestions: ["/some/path/ssh_keys"]
2733 description: "Handler module",
2734 suggestions: ["Pleroma.BBS.Handler"]
2739 description: "Port to connect",
2740 suggestions: [10_022]
2743 key: :password_authenticator,
2745 description: "Authenticator module",
2746 suggestions: ["Pleroma.BBS.Authenticator"]
2752 label: "Mime Types",
2754 description: "Mime Types settings",
2761 "application/xml" => ["xml"],
2762 "application/xrd+xml" => ["xrd+xml"],
2763 "application/jrd+json" => ["jrd+json"],
2764 "application/activity+json" => ["activity+json"],
2765 "application/ld+json" => ["activity+json"]
2770 key: "application/xml",
2771 type: {:list, :string},
2772 suggestions: ["xml"]
2775 key: "application/xrd+xml",
2776 type: {:list, :string},
2777 suggestions: ["xrd+xml"]
2780 key: "application/jrd+json",
2781 type: {:list, :string},
2782 suggestions: ["jrd+json"]
2785 key: "application/activity+json",
2786 type: {:list, :string},
2787 suggestions: ["activity+json"]
2790 key: "application/ld+json",
2791 type: {:list, :string},
2792 suggestions: ["activity+json"]
2802 description: "Pleroma chat settings",
2815 description: "HTTP settings",
2820 type: [:string, :tuple],
2821 description: "Proxy URL",
2822 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2825 key: :send_user_agent,
2830 type: [:string, :atom],
2832 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2833 suggestions: ["Pleroma", :default]
2838 description: "Adapter specific options",
2844 label: "SSL Options",
2845 description: "SSL options for HTTP adapter",
2849 type: {:list, :atom},
2850 description: "List of TLS version to use",
2851 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2862 label: "Markup Settings",
2866 key: :allow_inline_images,
2870 key: :allow_headings,
2883 type: {:list, :module},
2885 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2886 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2896 key: :deny_follow_blocked,
2904 key: :mrf_normalize_markup,
2905 label: "MRF Normalize Markup",
2906 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2912 suggestions: [Pleroma.HTML.Scrubber.Default]
2922 key: :restricted_nicknames,
2923 type: {:list, :string},
2942 "ostatus_subscribe",
2961 label: "CORS plug config",
2967 suggestions: [86_400]
2971 type: {:list, :string},
2972 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2976 type: {:list, :string},
2979 "X-RateLimit-Reset",
2980 "X-RateLimit-Limit",
2981 "X-RateLimit-Remaining",
2992 type: {:list, :string},
2993 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2999 key: Pleroma.Plugs.RemoteIp,
3002 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3003 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3009 description: "Enable/disable the plug. Default: disabled."
3013 type: {:list, :string},
3015 "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]`."
3019 type: {:list, :string},
3021 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3025 type: {:list, :string},
3027 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3033 key: :web_cache_ttl,
3034 label: "Web cache TTL",
3037 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3043 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3044 suggestions: [30_000, nil]
3047 key: :activity_pub_question,
3049 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3050 suggestions: [30_000]
3060 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3065 description: "Enables the rendering of static HTML. Default: disabled."
3073 description: "Configure feed rendering",
3078 description: "Configure title rendering",
3083 description: "Maximum number of characters before truncating title",
3089 description: "Replacement which will be used after truncating string",
3090 suggestions: ["..."]
3098 key: :mrf_object_age,
3099 label: "MRF Object Age",
3103 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3108 description: "Required age (in seconds) of a post before actions are taken.",
3109 suggestions: [172_800]
3113 type: {:list, :atom},
3115 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3116 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3117 "`:reject` rejects the message entirely",
3118 suggestions: [:delist, :strip_followers, :reject]
3126 description: "Custom Runtime Modules",
3131 description: "A path to custom Elixir modules (such as MRF policies)."
3139 description: "Settings for notifications streamer",
3144 description: "Number of workers to send notifications",
3148 key: :overflow_workers,
3150 description: "Maximum number of workers created if pool is empty",
3157 key: :connections_pool,
3159 description: "Advanced settings for `gun` connections pool",
3162 key: :checkin_timeout,
3164 description: "Timeout to checkin connection from pool. Default: 250ms.",
3168 key: :max_connections,
3170 description: "Maximum number of connections in the pool. Default: 250 connections.",
3177 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3181 key: :retry_timeout,
3184 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3188 key: :await_up_timeout,
3190 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3199 description: "Advanced settings for `gun` workers pools",
3204 description: "Settings for federation pool.",
3209 description: "Number workers in the pool.",
3215 description: "Number of additional workers if pool is under load.",
3221 description: "Timeout while `gun` will wait for response.",
3222 suggestions: [150_000]
3229 description: "Settings for media pool.",
3234 description: "Number workers in the pool.",
3240 description: "Number of additional workers if pool is under load.",
3246 description: "Timeout while `gun` will wait for response.",
3247 suggestions: [150_000]
3254 description: "Settings for upload pool.",
3259 description: "Number workers in the pool.",
3265 description: "Number of additional workers if pool is under load.",
3271 description: "Timeout while `gun` will wait for response.",
3272 suggestions: [300_000]
3279 description: "Settings for default pool.",
3284 description: "Number workers in the pool.",
3290 description: "Number of additional workers if pool is under load.",
3296 description: "Timeout while `gun` will wait for response.",
3297 suggestions: [10_000]
3305 key: :hackney_pools,
3307 description: "Advanced settings for `hackney` connections pools",
3312 description: "Settings for federation pool.",
3315 key: :max_connections,
3317 description: "Number workers in the pool.",
3323 description: "Timeout while `hackney` will wait for response.",
3324 suggestions: [150_000]
3331 description: "Settings for media pool.",
3334 key: :max_connections,
3336 description: "Number workers in the pool.",
3342 description: "Timeout while `hackney` will wait for response.",
3343 suggestions: [150_000]
3350 description: "Settings for upload pool.",
3353 key: :max_connections,
3355 description: "Number workers in the pool.",
3361 description: "Timeout while `hackney` will wait for response.",
3362 suggestions: [300_000]
3370 key: :restrict_unauthenticated,
3373 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3378 description: "Settings for public and federated timelines.",
3383 description: "Disallow view public timeline."
3388 description: "Disallow view federated timeline."
3395 description: "Settings for user profiles.",
3400 description: "Disallow view local user profiles."
3405 description: "Disallow view remote user profiles."
3412 description: "Settings for statuses.",
3417 description: "Disallow view local statuses."
3422 description: "Disallow view remote statuses."
3430 key: Pleroma.Web.ApiSpec.CastAndValidate,
3437 "Enables strict input validation (useful in development, not recommended in production)"
3443 key: :instances_favicons,
3445 description: "Control favicons for instances",
3450 description: "Allow/disallow displaying and getting instances favicons"
3458 descriptions: "S3 service related settings",
3461 key: :access_key_id,
3463 description: "S3 access key ID",
3464 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3467 key: :secret_access_key,
3469 description: "Secret access key",
3470 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3475 description: "S3 host",
3476 suggestions: ["s3.eu-central-1.amazonaws.com"]