2 alias Pleroma.Docs.Generator
7 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
8 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
15 config :pleroma, :config_description, [
20 description: "Upload general settings",
25 description: "Module which will be used for uploads",
26 suggestions: [Pleroma.Uploaders.Local, Pleroma.Uploaders.S3]
30 type: {:list, :module},
32 "List of filter modules for uploads. Module names are shortened (removed leading `Pleroma.Upload.Filter.` part), but on adding custom module you need to use full name.",
34 Generator.list_modules_in_dir(
35 "lib/pleroma/upload/filter",
36 "Elixir.Pleroma.Upload.Filter."
43 "If enabled, a name parameter will be added to the URL of the upload. For example `https://instance.tld/media/imagehash.png?name=realname.png`."
49 description: "Base URL for the uploads, needed if you use CDN",
51 "https://cdn-host.com"
58 "If enabled, requests to media stored using a remote uploader will be proxied instead of being redirected"
62 label: "Proxy Options",
64 description: "Options for Pleroma.ReverseProxy",
66 redirect_on_failure: false,
67 max_body_length: 25 * 1_048_576,
69 follow_redirect: true,
75 key: :redirect_on_failure,
78 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
79 "Any error during body processing will not be redirected as the response is chunked."
82 key: :max_body_length,
85 "Limits the content length to be approximately the " <>
86 "specified length. It is validated with the `content-length` header and also verified when proxying."
92 description: "HTTP options",
97 description: "Adapter specific options",
102 label: "SSL Options",
103 description: "SSL options for HTTP adapter",
107 type: {:list, :atom},
108 description: "List of TLS versions to use",
109 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
118 type: [:string, :tuple],
119 description: "Proxy URL",
120 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
127 key: :filename_display_max_length,
129 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
135 key: Pleroma.Uploaders.Local,
137 description: "Local uploader-related settings",
142 description: "Path where user's uploads will be saved",
151 key: Pleroma.Uploaders.S3,
153 description: "S3 uploader-related settings",
158 description: "S3 bucket",
164 key: :bucket_namespace,
166 description: "S3 bucket namespace",
167 suggestions: ["pleroma"]
170 key: :public_endpoint,
172 description: "S3 endpoint",
173 suggestions: ["https://s3.amazonaws.com"]
176 key: :truncated_namespace,
179 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
180 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in public_endpoint."
183 key: :streaming_enabled,
186 "Enable streaming uploads, when enabled the file will be sent to the server in chunks as it's being read. This may be unsupported by some providers, try disabling this if you have upload problems."
192 key: Pleroma.Upload.Filter.Mogrify,
194 description: "Uploads mogrify filter settings",
198 type: [:string, {:list, :string}, {:list, :tuple}],
200 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
201 "For example `[\"auto-orient\", \"strip\", {\"resize\", \"3840x1080>\"}]` string will be parsed into list of the settings.",
212 key: Pleroma.Upload.Filter.AnonymizeFilename,
214 description: "Filter replaces the filename of the upload",
220 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
221 " filename extension by using {extension}, for example custom-file-name.{extension}.",
223 "custom-file-name.{extension}"
230 key: Pleroma.Emails.Mailer,
232 description: "Mailer-related settings",
238 "One of the mail adapters listed in [Swoosh readme](https://github.com/swoosh/swoosh#adapters)," <>
239 " or Swoosh.Adapters.Local for in-memory mailbox",
241 Swoosh.Adapters.SMTP,
242 Swoosh.Adapters.Sendgrid,
243 Swoosh.Adapters.Sendmail,
244 Swoosh.Adapters.Mandrill,
245 Swoosh.Adapters.Mailgun,
246 Swoosh.Adapters.Mailjet,
247 Swoosh.Adapters.Postmark,
248 Swoosh.Adapters.SparkPost,
249 Swoosh.Adapters.AmazonSES,
251 Swoosh.Adapters.SocketLabs,
252 Swoosh.Adapters.Gmail,
253 Swoosh.Adapters.Local
259 description: "Allow/disallow send emails"
262 group: {:subgroup, Swoosh.Adapters.SMTP},
265 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
266 suggestions: ["smtp.gmail.com"]
269 group: {:subgroup, Swoosh.Adapters.SMTP},
272 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
273 suggestions: ["pleroma"]
276 group: {:subgroup, Swoosh.Adapters.SMTP},
279 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
280 suggestions: ["password"]
283 group: {:subgroup, Swoosh.Adapters.SMTP},
287 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
290 group: {:subgroup, Swoosh.Adapters.SMTP},
294 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
295 suggestions: [:always, :never, :if_available]
298 group: {:subgroup, Swoosh.Adapters.SMTP},
301 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
302 suggestions: [:always, :never, :if_available]
305 group: {:subgroup, Swoosh.Adapters.SMTP},
308 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
312 group: {:subgroup, Swoosh.Adapters.SMTP},
315 description: "`Swoosh.Adapters.SMTP` adapter specific setting",
319 group: {:subgroup, Swoosh.Adapters.SMTP},
321 label: "No MX lookups",
323 description: "`Swoosh.Adapters.SMTP` adapter specific setting"
326 group: {:subgroup, Swoosh.Adapters.Sendgrid},
330 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
331 suggestions: ["my-api-key"]
334 group: {:subgroup, Swoosh.Adapters.Sendmail},
337 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
338 suggestions: ["/usr/bin/sendmail"]
341 group: {:subgroup, Swoosh.Adapters.Sendmail},
344 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
345 suggestions: ["-N delay,failure,success"]
348 group: {:subgroup, Swoosh.Adapters.Sendmail},
351 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
354 group: {:subgroup, Swoosh.Adapters.Mandrill},
358 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
359 suggestions: ["my-api-key"]
362 group: {:subgroup, Swoosh.Adapters.Mailgun},
366 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
367 suggestions: ["my-api-key"]
370 group: {:subgroup, Swoosh.Adapters.Mailgun},
373 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
374 suggestions: ["pleroma.com"]
377 group: {:subgroup, Swoosh.Adapters.Mailjet},
381 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
382 suggestions: ["my-api-key"]
385 group: {:subgroup, Swoosh.Adapters.Mailjet},
388 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
389 suggestions: ["my-secret-key"]
392 group: {:subgroup, Swoosh.Adapters.Postmark},
396 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
397 suggestions: ["my-api-key"]
400 group: {:subgroup, Swoosh.Adapters.SparkPost},
404 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
405 suggestions: ["my-api-key"]
408 group: {:subgroup, Swoosh.Adapters.SparkPost},
411 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
412 suggestions: ["https://api.sparkpost.com/api/v1"]
415 group: {:subgroup, Swoosh.Adapters.AmazonSES},
418 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
419 suggestions: ["us-east-1", "us-east-2"]
422 group: {:subgroup, Swoosh.Adapters.AmazonSES},
425 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
426 suggestions: ["aws-access-key"]
429 group: {:subgroup, Swoosh.Adapters.AmazonSES},
432 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
433 suggestions: ["aws-secret-key"]
436 group: {:subgroup, Swoosh.Adapters.Dyn},
440 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
441 suggestions: ["my-api-key"]
444 group: {:subgroup, Swoosh.Adapters.SocketLabs},
447 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
450 group: {:subgroup, Swoosh.Adapters.SocketLabs},
454 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
457 group: {:subgroup, Swoosh.Adapters.Gmail},
460 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
467 description: "`Swoosh.Adapters.Local` adapter specific settings",
470 group: {:subgroup, Swoosh.Adapters.Local},
473 description: "Run the preview server together as part of your app"
476 group: {:subgroup, Swoosh.Adapters.Local},
479 description: "The preview server port",
487 label: "URI Schemes",
489 description: "URI schemes related settings",
493 type: {:list, :string},
494 description: "List of the scheme part that is considered valid to be an URL",
519 description: "Instance-related settings",
524 description: "Name of the instance",
531 label: "Admin Email Address",
533 description: "Email used to reach an Administrator/Moderator of the instance",
540 label: "Sender Email Address",
542 description: "Envelope FROM address for mail sent via Pleroma",
551 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
559 description: "Posts character limit (CW/Subject included in the counter)",
567 description: "Character limit of the instance chat messages",
575 description: "Hard character limit beyond which remote posts will be dropped",
583 description: "File size limit of uploads (except for avatar, background, banner)",
589 key: :avatar_upload_limit,
591 description: "File size limit of user's profile avatars",
597 key: :background_upload_limit,
599 description: "File size limit of user's profile backgrounds",
605 key: :banner_upload_limit,
607 description: "File size limit of user's profile banners",
615 description: "A map with poll limits for local polls",
619 max_option_chars: 200,
621 max_expiration: 31_536_000
628 description: "Maximum number of options",
632 key: :max_option_chars,
634 description: "Maximum number of characters per option",
638 key: :min_expiration,
640 description: "Minimum expiration time (in seconds)",
644 key: :max_expiration,
646 description: "Maximum expiration time (in seconds)",
652 key: :registrations_open,
655 "Enable registrations for anyone. Invitations require this setting to be disabled."
658 key: :invites_enabled,
661 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
664 key: :account_activation_required,
666 description: "Require users to confirm their emails before signing in"
671 description: "Enable federation with other instances"
674 key: :federation_incoming_replies_max_depth,
675 label: "Fed. incoming replies max depth",
678 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
679 " fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes.",
685 key: :federation_reachability_timeout_days,
686 label: "Fed. reachability timeout days",
689 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
697 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
703 "Makes the client API in authenticated mode-only except for user-profiles." <>
704 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
705 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
708 key: :quarantined_instances,
709 type: {:list, :string},
711 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
718 key: :managed_config,
721 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
726 description: "Instance static directory",
732 key: :allowed_post_formats,
733 type: {:list, :string},
734 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
743 key: :extended_nickname_format,
746 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
747 " This will break federation with older software for theses nicknames."
750 key: :cleanup_attachments,
753 Enable to remove associated attachments when status is removed.
754 This will not affect duplicates and attachments without status.
755 Enabling this will increase load to database when deleting statuses on larger instances.
759 key: :max_pinned_statuses,
761 description: "The maximum number of pinned statuses. 0 will disable the feature.",
769 key: :autofollowed_nicknames,
770 type: {:list, :string},
772 "Set to nicknames of (local) users that every new user should automatically follow",
781 key: :attachment_links,
783 description: "Enable to automatically add attachment link text to statuses"
786 key: :welcome_message,
789 "A message that will be sent to a newly registered users as a direct message",
791 "Hi, @username! Welcome on board!"
795 key: :welcome_user_nickname,
797 description: "The nickname of the local user that sends the welcome message",
803 key: :max_report_comment_size,
805 description: "The maximum size of the report comment. Default: 1000.",
811 key: :safe_dm_mentions,
812 label: "Safe DM mentions",
815 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
816 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
822 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
825 key: :remote_post_retention_days,
828 "The default amount of days to retain remote posts when pruning the database",
834 key: :user_bio_length,
836 description: "A user bio maximum length. Default: 5000.",
842 key: :user_name_length,
844 description: "A user name maximum length. Default: 100.",
850 key: :skip_thread_containment,
852 description: "Skip filtering out broken threads. Default: enabled."
855 key: :limit_to_local_content,
856 type: {:dropdown, :atom},
858 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
866 key: :max_account_fields,
868 description: "The maximum number of custom fields in the user profile. Default: 10.",
874 key: :max_remote_account_fields,
877 "The maximum number of custom fields in the remote user profile. Default: 20.",
883 key: :account_field_name_length,
885 description: "An account field name maximum length. Default: 512.",
891 key: :account_field_value_length,
893 description: "An account field value maximum length. Default: 2048.",
899 key: :external_user_synchronization,
901 description: "Enabling following/followers counters synchronization for external users"
904 key: :multi_factor_authentication,
906 description: "Multi-factor authentication settings",
909 totp: [digits: 6, period: 30],
910 backup_codes: [number: 5, length: 16]
916 label: "TOTP settings",
918 description: "TOTP settings",
919 suggestions: [digits: 6, period: 30],
926 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
933 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
940 description: "MFA backup codes settings",
941 suggestions: [number: 5, length: 16],
947 description: "Number of backup codes to generate."
954 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
961 key: :instance_thumbnail,
964 "The instance thumbnail can be any image that represents your instance and is used by some apps or services when they display information about your instance.",
965 suggestions: ["/instance/thumbnail.jpeg"]
972 description: "Logger-related settings",
976 type: [:atom, :tuple, :module],
978 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
979 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
987 label: "ExSyslogger",
988 description: "ExSyslogger-related settings",
992 type: {:dropdown, :atom},
993 description: "Log level",
994 suggestions: [:debug, :info, :warn, :error]
1000 "A string that's prepended to every message, and is typically set to the app name",
1001 suggestions: ["pleroma"]
1006 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1007 suggestions: ["$metadata[$level] $message"]
1011 type: {:list, :atom},
1012 suggestions: [:request_id]
1020 label: "Console Logger",
1021 description: "Console logger settings",
1025 type: {:dropdown, :atom},
1026 description: "Log level",
1027 suggestions: [:debug, :info, :warn, :error]
1032 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1033 suggestions: ["$metadata[$level] $message"]
1037 type: {:list, :atom},
1038 suggestions: [:request_id]
1045 label: "Quack Logger",
1046 description: "Quack-related settings",
1050 type: {:dropdown, :atom},
1051 description: "Log level",
1052 suggestions: [:debug, :info, :warn, :error]
1056 type: {:list, :atom},
1057 description: "Configure which metadata you want to report on",
1074 label: "Webhook URL",
1076 description: "Configure the Slack incoming webhook",
1077 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1083 key: :frontend_configurations,
1086 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1087 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1088 "add your own configuration your settings all fields must be complete.",
1092 label: "Pleroma FE",
1094 description: "Settings for Pleroma FE",
1097 alwaysShowSubjectInput: true,
1098 background: "/static/aurora_borealis.jpg",
1099 collapseMessageWithSubject: false,
1102 hideFilteredStatuses: false,
1103 hideMutedPosts: false,
1104 hidePostStats: false,
1105 hideSitename: false,
1106 hideUserStats: false,
1107 loginMethod: "password",
1108 logo: "/static/logo.png",
1111 minimalScopesMode: false,
1112 noAttachmentLinks: false,
1113 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1114 postContentType: "text/plain",
1115 redirectRootLogin: "/main/friends",
1116 redirectRootNoLogin: "/main/all",
1118 sidebarRight: false,
1119 showFeaturesPanel: true,
1120 showInstanceSpecificPanel: false,
1121 subjectLineBehavior: "email",
1122 theme: "pleroma-dark",
1123 webPushNotifications: false
1128 key: :alwaysShowSubjectInput,
1129 label: "Always show subject input",
1131 description: "When disabled, auto-hide the subject field if it's empty"
1137 "URL of the background, unless viewing a user profile with a background that is set",
1138 suggestions: ["/images/city.jpg"]
1141 key: :collapseMessageWithSubject,
1142 label: "Collapse message with subject",
1145 "When a message has a subject (aka Content Warning), collapse it by default"
1149 label: "PleromaFE Chat",
1151 description: "Disables PleromaFE Chat component"
1157 description: "Enables green text on lines prefixed with the > character"
1160 key: :hideFilteredStatuses,
1161 label: "Hide Filtered Statuses",
1163 description: "Hides filtered statuses from timelines"
1166 key: :hideMutedPosts,
1167 label: "Hide Muted Posts",
1169 description: "Hides muted statuses from timelines"
1172 key: :hidePostStats,
1173 label: "Hide post stats",
1175 description: "Hide notices statistics (repeats, favorites, ...)"
1179 label: "Hide Sitename",
1181 description: "Hides instance name from PleromaFE banner"
1184 key: :hideUserStats,
1185 label: "Hide user stats",
1188 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1193 description: "URL of the logo, defaults to Pleroma's logo",
1194 suggestions: ["/static/logo.png"]
1198 label: "Logo margin",
1201 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1202 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1203 suggestions: [".1em"]
1210 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1211 "If you want a colorful logo you must disable logoMask."
1214 key: :minimalScopesMode,
1215 label: "Minimal scopes mode",
1218 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1219 "Also prevents replying to a DM with a public post from PleromaFE."
1222 key: :nsfwCensorImage,
1223 label: "NSFW Censor Image",
1226 "URL of the image to use for hiding NSFW media attachments in the timeline",
1227 suggestions: ["/static/img/nsfw.74818f9.png"]
1230 key: :postContentType,
1231 label: "Post Content Type",
1232 type: {:dropdown, :atom},
1233 description: "Default post formatting option",
1234 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1237 key: :redirectRootNoLogin,
1238 label: "Redirect root no login",
1241 "Relative URL which indicates where to redirect when a user isn't logged in",
1242 suggestions: ["/main/all"]
1245 key: :redirectRootLogin,
1246 label: "Redirect root login",
1249 "Relative URL which indicates where to redirect when a user is logged in",
1250 suggestions: ["/main/friends"]
1254 label: "Scope copy",
1256 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1260 label: "Sidebar on Right",
1262 description: "Change alignment of sidebar and panels to the right"
1265 key: :showFeaturesPanel,
1266 label: "Show instance features panel",
1269 "Enables panel displaying functionality of the instance on the About page"
1272 key: :showInstanceSpecificPanel,
1273 label: "Show instance specific panel",
1275 description: "Whether to show the instance's custom panel"
1278 key: :subjectLineBehavior,
1279 label: "Subject line behavior",
1281 description: "Allows changing the default behaviour of subject lines in replies.
1282 `email`: copy and preprend re:, as in email,
1283 `masto`: copy verbatim, as in Mastodon,
1284 `noop`: don't copy the subject.",
1285 suggestions: ["email", "masto", "noop"]
1290 description: "Which theme to use. Available themes are defined in styles.json",
1291 suggestions: ["pleroma-dark"]
1299 description: "Settings for Masto FE",
1302 showInstanceSpecificPanel: true
1307 key: :showInstanceSpecificPanel,
1308 label: "Show instance specific panel",
1310 description: "Whenether to show the instance's specific panel"
1321 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1325 type: {:keyword, :map},
1327 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1330 url: "/images/pleroma-fox-tan-smol.png",
1331 mime_type: "image/png"
1333 pleroma_fox_tan_shy: %{
1334 url: "/images/pleroma-fox-tan-shy.png",
1335 mime_type: "image/png"
1340 key: :default_mascot,
1343 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1349 key: :default_user_avatar,
1351 description: "URL of the default user avatar",
1352 suggestions: ["/images/avi.png"]
1361 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1365 type: {:list, :map},
1366 description: "Describe the icons of the app",
1369 src: "/static/logo.png"
1372 src: "/static/icon.png",
1376 src: "/static/icon.ico",
1377 sizes: "72x72 96x96 128x128 256x256"
1384 description: "Describe the theme color of the app",
1385 suggestions: ["#282c37", "mediumpurple"]
1388 key: :background_color,
1390 description: "Describe the background color of the app",
1391 suggestions: ["#191b22", "aliceblue"]
1401 description: "General MRF settings",
1405 type: [:module, {:list, :module}],
1407 "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.",
1409 Generator.list_modules_in_dir(
1410 "lib/pleroma/web/activity_pub/mrf",
1411 "Elixir.Pleroma.Web.ActivityPub.MRF."
1416 label: "MRF transparency",
1419 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1422 key: :transparency_exclusions,
1423 label: "MRF transparency exclusions",
1424 type: {:list, :string},
1426 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1437 label: "MRF Simple",
1439 description: "Simple ingress policies",
1442 key: :media_removal,
1443 type: {:list, :string},
1444 description: "List of instances to strip media attachments from",
1445 suggestions: ["example.com", "*.example.com"]
1449 label: "Media NSFW",
1450 type: {:list, :string},
1451 description: "List of instances to tag all media as NSFW (sensitive) from",
1452 suggestions: ["example.com", "*.example.com"]
1455 key: :federated_timeline_removal,
1456 type: {:list, :string},
1458 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1459 suggestions: ["example.com", "*.example.com"]
1463 type: {:list, :string},
1464 description: "List of instances to reject activities from (except deletes)",
1465 suggestions: ["example.com", "*.example.com"]
1469 type: {:list, :string},
1470 description: "List of instances to only accept activities from (except deletes)",
1471 suggestions: ["example.com", "*.example.com"]
1474 key: :report_removal,
1475 type: {:list, :string},
1476 description: "List of instances to reject reports from",
1477 suggestions: ["example.com", "*.example.com"]
1480 key: :avatar_removal,
1481 type: {:list, :string},
1482 description: "List of instances to strip avatars from",
1483 suggestions: ["example.com", "*.example.com"]
1486 key: :banner_removal,
1487 type: {:list, :string},
1488 description: "List of instances to strip banners from",
1489 suggestions: ["example.com", "*.example.com"]
1492 key: :reject_deletes,
1493 type: {:list, :string},
1494 description: "List of instances to reject deletions from",
1495 suggestions: ["example.com", "*.example.com"]
1501 key: :mrf_activity_expiration,
1503 label: "MRF Activity Expiration Policy",
1505 description: "Adds automatic expiration to all local activities",
1510 description: "Default global expiration time for all local activities (in days)",
1511 suggestions: [90, 365]
1519 label: "MRF Subchain",
1522 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1523 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1527 type: {:map, {:list, :string}},
1528 description: "Matches a series of regular expressions against the actor field",
1531 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1539 key: :mrf_rejectnonpublic,
1541 description: "RejectNonPublic drops posts with non-public visibility settings.",
1542 label: "MRF Reject Non Public",
1546 key: :allow_followersonly,
1547 label: "Allow followers-only",
1549 description: "Whether to allow followers-only posts"
1554 description: "Whether to allow direct messages"
1560 key: :mrf_hellthread,
1562 label: "MRF Hellthread",
1564 description: "Block messages with excessive user mentions",
1567 key: :delist_threshold,
1570 "Number of mentioned users after which the message gets removed from timelines and" <>
1571 "disables notifications. Set to 0 to disable.",
1575 key: :reject_threshold,
1578 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1587 label: "MRF Keyword",
1589 description: "Reject or Word-Replace messages with a keyword or regex",
1593 type: {:list, :string},
1595 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1596 suggestions: ["foo", ~r/foo/iu]
1599 key: :federated_timeline_removal,
1600 type: {:list, :string},
1602 "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.",
1603 suggestions: ["foo", ~r/foo/iu]
1607 type: {:list, :tuple},
1609 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1610 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1618 label: "MRF Mention",
1620 description: "Block messages which mention a specific user",
1624 type: {:list, :string},
1625 description: "A list of actors for which any post mentioning them will be dropped",
1626 suggestions: ["actor1", "actor2"]
1632 key: :mrf_vocabulary,
1634 label: "MRF Vocabulary",
1636 description: "Filter messages which belong to certain activity vocabularies",
1640 type: {:list, :string},
1642 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1643 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1647 type: {:list, :string},
1649 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1650 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1656 # key: :mrf_user_allowlist,
1659 # "The keys in this section are the domain names that the policy should apply to." <>
1660 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1662 # %{"example.org" => ["https://example.org/users/admin"]}
1670 description: "Media proxy",
1675 description: "Enables proxying of remote media to the instance's proxy"
1682 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1683 suggestions: ["https://example.com"]
1691 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1697 description: "Enables invalidate media cache"
1702 description: "Module which will be used to cache purge.",
1704 Pleroma.Web.MediaProxy.Invalidation.Script,
1705 Pleroma.Web.MediaProxy.Invalidation.Http
1712 label: "Proxy Options",
1714 description: "Options for Pleroma.ReverseProxy",
1716 redirect_on_failure: false,
1717 max_body_length: 25 * 1_048_576,
1719 follow_redirect: true,
1725 key: :redirect_on_failure,
1728 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1729 "Any error during body processing will not be redirected as the response is chunked."
1732 key: :max_body_length,
1735 "Limits the content length to be approximately the " <>
1736 "specified length. It is validated with the `content-length` header and also verified when proxying."
1742 description: "HTTP options",
1747 description: "Adapter specific options",
1752 label: "SSL Options",
1753 description: "SSL options for HTTP adapter",
1757 type: {:list, :atom},
1758 description: "List of TLS version to use",
1759 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1768 type: [:string, :tuple],
1769 description: "Proxy URL",
1770 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1778 type: {:list, :string},
1779 description: "List of domains to bypass the mediaproxy",
1780 suggestions: ["example.com"]
1786 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1788 description: "HTTP invalidate settings",
1793 description: "HTTP method of request. Default: :purge"
1797 type: {:keyword, :string},
1798 description: "HTTP headers of request",
1799 suggestions: [{"x-refresh", 1}]
1804 description: "Request options",
1808 type: {:map, :string}
1816 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1818 description: "Script invalidate settings",
1823 description: "Path to shell script. Which will run purge cache.",
1824 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1832 description: "Gopher settings",
1837 description: "Enables the gopher interface"
1843 description: "IP address to bind to",
1844 suggestions: [{0, 0, 0, 0}]
1849 description: "Port to bind to",
1855 description: "Port advertised in URLs (optional, defaults to port)",
1863 label: "ActivityPub",
1865 description: "ActivityPub-related settings",
1868 key: :unfollow_blocked,
1870 description: "Whether blocks result in people getting unfollowed"
1873 key: :outgoing_blocks,
1875 description: "Whether to federate blocks to other instances"
1878 key: :sign_object_fetches,
1880 description: "Sign object fetches with HTTP signatures"
1883 key: :note_replies_output_limit,
1886 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1889 key: :follow_handshake_timeout,
1891 description: "Following handshake timeout",
1898 key: :http_security,
1899 label: "HTTP security",
1901 description: "HTTP security settings",
1906 description: "Whether the managed content security policy is enabled"
1912 description: "Whether to additionally send a Strict-Transport-Security header"
1916 label: "STS max age",
1918 description: "The maximum age for the Strict-Transport-Security header if sent",
1919 suggestions: [31_536_000]
1923 label: "CT max age",
1925 description: "The maximum age for the Expect-CT header if sent",
1926 suggestions: [2_592_000]
1929 key: :referrer_policy,
1931 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1932 suggestions: ["same-origin", "no-referrer"]
1936 label: "Report URI",
1938 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1939 suggestions: ["https://example.com/report-uri"]
1944 group: :web_push_encryption,
1945 key: :vapid_details,
1946 label: "Vapid Details",
1949 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1955 "A mailto link for the administrative contact." <>
1956 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1957 suggestions: ["mailto:moderators@pleroma.com"]
1962 description: "VAPID public key",
1963 suggestions: ["Public key"]
1968 description: "VAPID private key",
1969 suggestions: ["Private key"]
1975 key: Pleroma.Captcha,
1977 description: "Captcha-related settings",
1982 description: "Whether the captcha should be shown on registration"
1987 description: "The method/service to use for captcha",
1988 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1991 key: :seconds_valid,
1993 description: "The time in seconds for which the captcha is valid",
2000 key: Pleroma.Captcha.Kocaptcha,
2003 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2004 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2009 description: "The kocaptcha endpoint to use",
2010 suggestions: ["https://captcha.kotobank.ch"]
2016 label: "Pleroma Admin Token",
2019 "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",
2024 description: "Admin token",
2025 suggestions: ["We recommend a secure random string or UUID"]
2034 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2036 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2037 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2038 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2039 (see https://github.com/sorentwo/oban/issues/52).
2044 type: {:dropdown, :atom},
2045 description: "Logs verbose mode",
2046 suggestions: [false, :error, :warn, :info, :debug]
2050 type: {:keyword, :integer},
2052 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2054 activity_expiration: 10,
2055 attachments_cleanup: 5,
2057 federator_incoming: 50,
2058 federator_outgoing: 50,
2060 scheduled_activities: 10,
2066 key: :activity_expiration,
2068 description: "Activity expiration queue",
2072 key: :attachments_cleanup,
2074 description: "Attachment deletion queue",
2080 description: "Background queue",
2084 key: :federator_incoming,
2086 description: "Incoming federation queue",
2090 key: :federator_outgoing,
2092 description: "Outgoing federation queue",
2098 description: "Email sender queue, see Pleroma.Emails.Mailer",
2102 key: :scheduled_activities,
2104 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2108 key: :transmogrifier,
2110 description: "Transmogrifier queue",
2116 description: "Web push notifications queue",
2123 type: {:list, :tuple},
2124 description: "Settings for cron background jobs",
2126 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2127 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2128 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2129 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2130 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2139 description: "Includes custom worker options not interpretable directly by `Oban`",
2143 type: {:keyword, :integer},
2144 description: "Max retry attempts for failed jobs, per `Oban` queue",
2146 federator_incoming: 5,
2147 federator_outgoing: 5
2154 key: Pleroma.Web.Metadata,
2156 description: "Metadata-related settings",
2160 type: {:list, :module},
2161 description: "List of metadata providers to enable",
2163 Pleroma.Web.Metadata.Providers.OpenGraph,
2164 Pleroma.Web.Metadata.Providers.TwitterCard,
2165 Pleroma.Web.Metadata.Providers.RelMe,
2166 Pleroma.Web.Metadata.Providers.Feed
2171 label: "Unfurl NSFW",
2173 description: "When enabled NSFW attachments will be shown in previews"
2182 "If enabled the instance will parse metadata from attached links to generate link previews",
2187 description: "Enables RichMedia parsing of URLs"
2191 type: {:list, :string},
2192 description: "List of hosts which will be ignored by the metadata parser",
2193 suggestions: ["accounts.google.com", "xss.website"]
2197 label: "Ignore TLD",
2198 type: {:list, :string},
2199 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2200 suggestions: ["local", "localdomain", "lan"]
2204 type: {:list, :module},
2206 "List of Rich Media parsers. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parsers.` part), but on adding custom module you need to use full name.",
2208 Pleroma.Web.RichMedia.Parsers.OEmbed,
2209 Pleroma.Web.RichMedia.Parsers.TwitterCard
2214 label: "TTL setters",
2215 type: {:list, :module},
2217 "List of rich media TTL setters. Module names are shortened (removed leading `Pleroma.Web.RichMedia.Parser.` part), but on adding custom module you need to use full name.",
2219 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2225 group: :auto_linker,
2227 label: "Auto Linker",
2229 description: "Configuration for the auto_linker library",
2233 type: [:string, false],
2234 description: "Specify the class to be added to the generated link. Disable to clear.",
2235 suggestions: ["auto-linker", false]
2239 type: [:string, false],
2240 description: "Override the rel attribute. Disable to clear.",
2241 suggestions: ["ugc", "noopener noreferrer", false]
2246 description: "Link URLs will open in new window/tab"
2250 type: [:integer, false],
2252 "Set to a number to truncate URLs longer then the number. Truncated URLs will end in `..`",
2253 suggestions: [15, false]
2258 description: "Strip the scheme prefix"
2263 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2269 key: Pleroma.ScheduledActivity,
2271 description: "Scheduled activities settings",
2274 key: :daily_user_limit,
2277 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2281 key: :total_user_limit,
2284 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2290 description: "Whether scheduled activities are sent to the job queue to be executed"
2296 key: Pleroma.ActivityExpiration,
2298 description: "Expired activity settings",
2303 description: "Whether expired activities will be sent to the job queue to be deleted"
2309 label: "Pleroma Authenticator",
2311 description: "Authenticator",
2314 key: Pleroma.Web.Auth.Authenticator,
2316 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2326 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2327 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2328 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2329 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2334 description: "Enables LDAP authentication"
2339 description: "LDAP server hostname",
2340 suggestions: ["localhosts"]
2345 description: "LDAP port, e.g. 389 or 636",
2346 suggestions: [389, 636]
2352 description: "Enable to use SSL, usually implies the port 636"
2356 label: "SSL options",
2358 description: "Additional SSL options",
2359 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2364 description: "Path to file with PEM encoded cacerts",
2365 suggestions: ["path/to/file/with/PEM/cacerts"]
2370 description: "Type of cert verification",
2371 suggestions: [:verify_peer]
2379 description: "Enable to use STARTTLS, usually implies the port 389"
2383 label: "TLS options",
2385 description: "Additional TLS options",
2386 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2391 description: "Path to file with PEM encoded cacerts",
2392 suggestions: ["path/to/file/with/PEM/cacerts"]
2397 description: "Type of cert verification",
2398 suggestions: [:verify_peer]
2405 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2406 suggestions: ["dc=example,dc=com"]
2413 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2422 description: "Authentication / authorization settings",
2425 key: :enforce_oauth_admin_scope_usage,
2426 label: "Enforce OAuth admin scope usage",
2429 "OAuth admin scope requirement toggle. " <>
2430 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2431 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2432 "`is_admin` user flag grants access to admin-specific actions."
2435 key: :auth_template,
2438 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2439 suggestions: ["show.html"]
2442 key: :oauth_consumer_template,
2443 label: "OAuth consumer template",
2446 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2447 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2448 suggestions: ["consumer.html"]
2451 key: :oauth_consumer_strategies,
2452 label: "OAuth consumer strategies",
2453 type: {:list, :string},
2455 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2456 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2457 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2458 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2464 key: :email_notifications,
2466 description: "Email notifications settings",
2472 "emails of \"what you've missed\" for users who have been inactive for a while",
2476 schedule: "0 0 * * 0",
2478 inactivity_threshold: 7
2486 description: "Globally enable or disable digest emails"
2492 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2493 suggestions: ["0 0 * * 0"]
2498 description: "Minimum interval between digest emails to one user",
2502 key: :inactivity_threshold,
2504 description: "Minimum user inactivity threshold",
2513 key: Pleroma.Emails.UserEmail,
2515 description: "Email template settings",
2520 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2521 suggestions: ["some/path/logo.png"]
2526 description: "A map with color settings for email templates.",
2529 link_color: "#d8a070",
2530 background_color: "#2C3645",
2531 content_background_color: "#1B2635",
2532 header_color: "#d8a070",
2533 text_color: "#b9b9ba",
2534 text_muted_color: "#b9b9ba"
2541 suggestions: ["#d8a070"]
2544 key: :background_color,
2546 suggestions: ["#2C3645"]
2549 key: :content_background_color,
2551 suggestions: ["#1B2635"]
2556 suggestions: ["#d8a070"]
2561 suggestions: ["#b9b9ba"]
2564 key: :text_muted_color,
2566 suggestions: ["#b9b9ba"]
2574 key: Pleroma.Emails.NewUsersDigestEmail,
2576 description: "New users admin email digest",
2581 description: "Enables new users admin digest email when `true`"
2590 description: "Configure OAuth 2 provider capabilities",
2593 key: :token_expires_in,
2595 description: "The lifetime in seconds of the access token",
2599 key: :issue_new_refresh_token,
2602 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2605 key: :clean_expired_tokens,
2607 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2617 key: :shortcode_globs,
2618 type: {:list, :string},
2619 description: "Location of custom emoji files. * can be used as a wildcard.",
2620 suggestions: ["/emoji/custom/**/*.png"]
2623 key: :pack_extensions,
2624 type: {:list, :string},
2626 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2627 suggestions: [".png", ".gif"]
2631 type: {:keyword, {:list, :string}},
2633 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2634 " and the value is the location or array of locations. * can be used as a wildcard.",
2636 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2640 key: :default_manifest,
2643 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2644 " Currently only one manifest can be added (no arrays).",
2645 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2648 key: :shared_pack_cache_seconds_per_file,
2649 label: "Shared pack cache s/file",
2652 "When an emoji pack is shared, the archive is created and cached in memory" <>
2653 " for this amount of seconds multiplied by the number of files.",
2663 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2667 type: [:tuple, {:list, :tuple}],
2668 description: "For the search requests (account & status search etc.)",
2669 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2673 type: [:tuple, {:list, :tuple}],
2674 description: "For requests to timelines (each timeline has it's own limiter)",
2675 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2678 key: :app_account_creation,
2679 type: [:tuple, {:list, :tuple}],
2680 description: "For registering user accounts from the same IP address",
2681 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2684 key: :relations_actions,
2685 type: [:tuple, {:list, :tuple}],
2686 description: "For actions on relationships with all users (follow, unfollow)",
2687 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2690 key: :relation_id_action,
2691 label: "Relation ID action",
2692 type: [:tuple, {:list, :tuple}],
2693 description: "For actions on relation with a specific user (follow, unfollow)",
2694 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2697 key: :statuses_actions,
2698 type: [:tuple, {:list, :tuple}],
2700 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2701 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2704 key: :status_id_action,
2705 label: "Status ID action",
2706 type: [:tuple, {:list, :tuple}],
2708 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2709 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2712 key: :authentication,
2713 type: [:tuple, {:list, :tuple}],
2714 description: "For authentication create / password check / user existence check requests",
2715 suggestions: [{60_000, 15}]
2724 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2725 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2730 description: "Enables SSH"
2735 description: "Dir with SSH keys",
2736 suggestions: ["/some/path/ssh_keys"]
2741 description: "Handler module",
2742 suggestions: ["Pleroma.BBS.Handler"]
2747 description: "Port to connect",
2748 suggestions: [10_022]
2751 key: :password_authenticator,
2753 description: "Authenticator module",
2754 suggestions: ["Pleroma.BBS.Authenticator"]
2760 label: "Mime Types",
2762 description: "Mime Types settings",
2769 "application/xml" => ["xml"],
2770 "application/xrd+xml" => ["xrd+xml"],
2771 "application/jrd+json" => ["jrd+json"],
2772 "application/activity+json" => ["activity+json"],
2773 "application/ld+json" => ["activity+json"]
2778 key: "application/xml",
2779 type: {:list, :string},
2780 suggestions: ["xml"]
2783 key: "application/xrd+xml",
2784 type: {:list, :string},
2785 suggestions: ["xrd+xml"]
2788 key: "application/jrd+json",
2789 type: {:list, :string},
2790 suggestions: ["jrd+json"]
2793 key: "application/activity+json",
2794 type: {:list, :string},
2795 suggestions: ["activity+json"]
2798 key: "application/ld+json",
2799 type: {:list, :string},
2800 suggestions: ["activity+json"]
2810 description: "Pleroma chat settings",
2823 description: "HTTP settings",
2828 type: [:string, :tuple],
2829 description: "Proxy URL",
2830 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2833 key: :send_user_agent,
2838 type: [:string, :atom],
2840 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2841 suggestions: ["Pleroma", :default]
2846 description: "Adapter specific options",
2852 label: "SSL Options",
2853 description: "SSL options for HTTP adapter",
2857 type: {:list, :atom},
2858 description: "List of TLS version to use",
2859 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2870 label: "Markup Settings",
2874 key: :allow_inline_images,
2878 key: :allow_headings,
2891 type: {:list, :module},
2893 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2894 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2904 key: :deny_follow_blocked,
2912 key: :mrf_normalize_markup,
2913 label: "MRF Normalize Markup",
2914 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2920 suggestions: [Pleroma.HTML.Scrubber.Default]
2930 key: :restricted_nicknames,
2931 type: {:list, :string},
2950 "ostatus_subscribe",
2969 label: "CORS plug config",
2975 suggestions: [86_400]
2979 type: {:list, :string},
2980 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2984 type: {:list, :string},
2987 "X-RateLimit-Reset",
2988 "X-RateLimit-Limit",
2989 "X-RateLimit-Remaining",
3000 type: {:list, :string},
3001 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3007 key: Pleroma.Plugs.RemoteIp,
3010 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3011 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3017 description: "Enable/disable the plug. Default: disabled."
3021 type: {:list, :string},
3023 "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]`."
3027 type: {:list, :string},
3029 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3033 type: {:list, :string},
3035 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3041 key: :web_cache_ttl,
3042 label: "Web cache TTL",
3045 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3051 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3052 suggestions: [30_000, nil]
3055 key: :activity_pub_question,
3057 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3058 suggestions: [30_000]
3068 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3073 description: "Enables the rendering of static HTML. Default: disabled."
3081 description: "Configure feed rendering",
3086 description: "Configure title rendering",
3091 description: "Maximum number of characters before truncating title",
3097 description: "Replacement which will be used after truncating string",
3098 suggestions: ["..."]
3106 key: :mrf_object_age,
3107 label: "MRF Object Age",
3111 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3116 description: "Required age (in seconds) of a post before actions are taken.",
3117 suggestions: [172_800]
3121 type: {:list, :atom},
3123 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3124 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3125 "`:reject` rejects the message entirely",
3126 suggestions: [:delist, :strip_followers, :reject]
3134 description: "Custom Runtime Modules",
3139 description: "A path to custom Elixir modules (such as MRF policies)."
3147 description: "Settings for notifications streamer",
3152 description: "Number of workers to send notifications",
3156 key: :overflow_workers,
3158 description: "Maximum number of workers created if pool is empty",
3165 key: :connections_pool,
3167 description: "Advanced settings for `gun` connections pool",
3170 key: :checkin_timeout,
3172 description: "Timeout to checkin connection from pool. Default: 250ms.",
3176 key: :max_connections,
3178 description: "Maximum number of connections in the pool. Default: 250 connections.",
3185 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
3189 key: :retry_timeout,
3192 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
3196 key: :await_up_timeout,
3198 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3207 description: "Advanced settings for `gun` workers pools",
3212 description: "Settings for federation pool.",
3217 description: "Number workers in the pool.",
3223 description: "Number of additional workers if pool is under load.",
3229 description: "Timeout while `gun` will wait for response.",
3230 suggestions: [150_000]
3237 description: "Settings for media pool.",
3242 description: "Number workers in the pool.",
3248 description: "Number of additional workers if pool is under load.",
3254 description: "Timeout while `gun` will wait for response.",
3255 suggestions: [150_000]
3262 description: "Settings for upload pool.",
3267 description: "Number workers in the pool.",
3273 description: "Number of additional workers if pool is under load.",
3279 description: "Timeout while `gun` will wait for response.",
3280 suggestions: [300_000]
3287 description: "Settings for default pool.",
3292 description: "Number workers in the pool.",
3298 description: "Number of additional workers if pool is under load.",
3304 description: "Timeout while `gun` will wait for response.",
3305 suggestions: [10_000]
3313 key: :hackney_pools,
3315 description: "Advanced settings for `hackney` connections pools",
3320 description: "Settings for federation pool.",
3323 key: :max_connections,
3325 description: "Number workers in the pool.",
3331 description: "Timeout while `hackney` will wait for response.",
3332 suggestions: [150_000]
3339 description: "Settings for media pool.",
3342 key: :max_connections,
3344 description: "Number workers in the pool.",
3350 description: "Timeout while `hackney` will wait for response.",
3351 suggestions: [150_000]
3358 description: "Settings for upload pool.",
3361 key: :max_connections,
3363 description: "Number workers in the pool.",
3369 description: "Timeout while `hackney` will wait for response.",
3370 suggestions: [300_000]
3378 key: :restrict_unauthenticated,
3381 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3386 description: "Settings for public and federated timelines.",
3391 description: "Disallow view public timeline."
3396 description: "Disallow view federated timeline."
3403 description: "Settings for user profiles.",
3408 description: "Disallow view local user profiles."
3413 description: "Disallow view remote user profiles."
3420 description: "Settings for statuses.",
3425 description: "Disallow view local statuses."
3430 description: "Disallow view remote statuses."
3438 key: Pleroma.Web.ApiSpec.CastAndValidate,
3445 "Enables strict input validation (useful in development, not recommended in production)"
3451 key: :instances_favicons,
3453 description: "Control favicons for instances",
3458 description: "Allow/disallow displaying and getting instances favicons"
3466 descriptions: "S3 service related settings",
3469 key: :access_key_id,
3471 description: "S3 access key ID",
3472 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3475 key: :secret_access_key,
3477 description: "Secret access key",
3478 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3483 description: "S3 host",
3484 suggestions: ["s3.eu-central-1.amazonaws.com"]