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"
665 key: :account_approval_required,
667 description: "Require users to be manually approved by an admin before signing in"
672 description: "Enable federation with other instances"
675 key: :federation_incoming_replies_max_depth,
676 label: "Fed. incoming replies max depth",
679 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
680 " 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.",
686 key: :federation_reachability_timeout_days,
687 label: "Fed. reachability timeout days",
690 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
698 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
704 "Makes the client API in authenticated mode-only except for user-profiles." <>
705 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
706 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
709 key: :quarantined_instances,
710 type: {:list, :string},
712 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
719 key: :managed_config,
722 "Whenether the config for pleroma-fe is configured in this config or in static/config.json"
727 description: "Instance static directory",
733 key: :allowed_post_formats,
734 type: {:list, :string},
735 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
744 key: :extended_nickname_format,
747 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
748 " This will break federation with older software for theses nicknames."
751 key: :cleanup_attachments,
754 Enable to remove associated attachments when status is removed.
755 This will not affect duplicates and attachments without status.
756 Enabling this will increase load to database when deleting statuses on larger instances.
760 key: :max_pinned_statuses,
762 description: "The maximum number of pinned statuses. 0 will disable the feature.",
770 key: :autofollowed_nicknames,
771 type: {:list, :string},
773 "Set to nicknames of (local) users that every new user should automatically follow",
782 key: :attachment_links,
784 description: "Enable to automatically add attachment link text to statuses"
787 key: :max_report_comment_size,
789 description: "The maximum size of the report comment. Default: 1000.",
795 key: :safe_dm_mentions,
796 label: "Safe DM mentions",
799 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
800 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
806 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
809 key: :remote_post_retention_days,
812 "The default amount of days to retain remote posts when pruning the database",
818 key: :user_bio_length,
820 description: "A user bio maximum length. Default: 5000.",
826 key: :user_name_length,
828 description: "A user name maximum length. Default: 100.",
834 key: :skip_thread_containment,
836 description: "Skip filtering out broken threads. Default: enabled."
839 key: :limit_to_local_content,
840 type: {:dropdown, :atom},
842 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
850 key: :max_account_fields,
852 description: "The maximum number of custom fields in the user profile. Default: 10.",
858 key: :max_remote_account_fields,
861 "The maximum number of custom fields in the remote user profile. Default: 20.",
867 key: :account_field_name_length,
869 description: "An account field name maximum length. Default: 512.",
875 key: :account_field_value_length,
877 description: "An account field value maximum length. Default: 2048.",
883 key: :registration_reason_length,
885 description: "Maximum registration reason length. Default: 500.",
891 key: :external_user_synchronization,
893 description: "Enabling following/followers counters synchronization for external users"
896 key: :multi_factor_authentication,
898 description: "Multi-factor authentication settings",
901 totp: [digits: 6, period: 30],
902 backup_codes: [number: 5, length: 16]
908 label: "TOTP settings",
910 description: "TOTP settings",
911 suggestions: [digits: 6, period: 30],
918 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
925 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
932 description: "MFA backup codes settings",
933 suggestions: [number: 5, length: 16],
939 description: "Number of backup codes to generate."
946 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
953 key: :instance_thumbnail,
956 "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.",
957 suggestions: ["/instance/thumbnail.jpeg"]
964 description: "Welcome messages settings",
967 group: :direct_message,
969 descpiption: "Direct message settings",
974 description: "Enables sends direct message for new user after registration"
980 "A message that will be sent to a newly registered users as a direct message",
982 "Hi, @username! Welcome on board!"
986 key: :sender_nickname,
988 description: "The nickname of the local user that sends the welcome message",
998 descpiption: "Email message settings",
1003 description: "Enables sends direct message for new user after registration"
1007 type: [:string, :tuple],
1009 "The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.",
1011 {"Pleroma App", "welcome@pleroma.app"}
1018 "The subject of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1019 suggestions: ["Welcome to <%= instance_name%>"]
1025 "The html content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1026 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1032 "The text content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1033 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1042 description: "Logger-related settings",
1046 type: [:atom, :tuple, :module],
1048 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1049 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1057 label: "ExSyslogger",
1058 description: "ExSyslogger-related settings",
1062 type: {:dropdown, :atom},
1063 description: "Log level",
1064 suggestions: [:debug, :info, :warn, :error]
1070 "A string that's prepended to every message, and is typically set to the app name",
1071 suggestions: ["pleroma"]
1076 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1077 suggestions: ["$metadata[$level] $message"]
1081 type: {:list, :atom},
1082 suggestions: [:request_id]
1090 label: "Console Logger",
1091 description: "Console logger settings",
1095 type: {:dropdown, :atom},
1096 description: "Log level",
1097 suggestions: [:debug, :info, :warn, :error]
1102 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1103 suggestions: ["$metadata[$level] $message"]
1107 type: {:list, :atom},
1108 suggestions: [:request_id]
1115 label: "Quack Logger",
1116 description: "Quack-related settings",
1120 type: {:dropdown, :atom},
1121 description: "Log level",
1122 suggestions: [:debug, :info, :warn, :error]
1126 type: {:list, :atom},
1127 description: "Configure which metadata you want to report on",
1144 label: "Webhook URL",
1146 description: "Configure the Slack incoming webhook",
1147 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1153 key: :frontend_configurations,
1156 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1157 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1158 "add your own configuration your settings all fields must be complete.",
1162 label: "Pleroma FE",
1164 description: "Settings for Pleroma FE",
1167 alwaysShowSubjectInput: true,
1168 background: "/static/aurora_borealis.jpg",
1169 collapseMessageWithSubject: false,
1172 hideFilteredStatuses: false,
1173 hideMutedPosts: false,
1174 hidePostStats: false,
1175 hideSitename: false,
1176 hideUserStats: false,
1177 loginMethod: "password",
1178 logo: "/static/logo.png",
1181 minimalScopesMode: false,
1182 noAttachmentLinks: false,
1183 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1184 postContentType: "text/plain",
1185 redirectRootLogin: "/main/friends",
1186 redirectRootNoLogin: "/main/all",
1188 sidebarRight: false,
1189 showFeaturesPanel: true,
1190 showInstanceSpecificPanel: false,
1191 subjectLineBehavior: "email",
1192 theme: "pleroma-dark",
1193 webPushNotifications: false
1198 key: :alwaysShowSubjectInput,
1199 label: "Always show subject input",
1201 description: "When disabled, auto-hide the subject field if it's empty"
1207 "URL of the background, unless viewing a user profile with a background that is set",
1208 suggestions: ["/images/city.jpg"]
1211 key: :collapseMessageWithSubject,
1212 label: "Collapse message with subject",
1215 "When a message has a subject (aka Content Warning), collapse it by default"
1219 label: "PleromaFE Chat",
1221 description: "Disables PleromaFE Chat component"
1227 description: "Enables green text on lines prefixed with the > character"
1230 key: :hideFilteredStatuses,
1231 label: "Hide Filtered Statuses",
1233 description: "Hides filtered statuses from timelines"
1236 key: :hideMutedPosts,
1237 label: "Hide Muted Posts",
1239 description: "Hides muted statuses from timelines"
1242 key: :hidePostStats,
1243 label: "Hide post stats",
1245 description: "Hide notices statistics (repeats, favorites, ...)"
1249 label: "Hide Sitename",
1251 description: "Hides instance name from PleromaFE banner"
1254 key: :hideUserStats,
1255 label: "Hide user stats",
1258 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1263 description: "URL of the logo, defaults to Pleroma's logo",
1264 suggestions: ["/static/logo.png"]
1268 label: "Logo margin",
1271 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1272 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1273 suggestions: [".1em"]
1280 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1281 "If you want a colorful logo you must disable logoMask."
1284 key: :minimalScopesMode,
1285 label: "Minimal scopes mode",
1288 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1289 "Also prevents replying to a DM with a public post from PleromaFE."
1292 key: :nsfwCensorImage,
1293 label: "NSFW Censor Image",
1296 "URL of the image to use for hiding NSFW media attachments in the timeline",
1297 suggestions: ["/static/img/nsfw.74818f9.png"]
1300 key: :postContentType,
1301 label: "Post Content Type",
1302 type: {:dropdown, :atom},
1303 description: "Default post formatting option",
1304 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1307 key: :redirectRootNoLogin,
1308 label: "Redirect root no login",
1311 "Relative URL which indicates where to redirect when a user isn't logged in",
1312 suggestions: ["/main/all"]
1315 key: :redirectRootLogin,
1316 label: "Redirect root login",
1319 "Relative URL which indicates where to redirect when a user is logged in",
1320 suggestions: ["/main/friends"]
1324 label: "Scope copy",
1326 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1330 label: "Sidebar on Right",
1332 description: "Change alignment of sidebar and panels to the right"
1335 key: :showFeaturesPanel,
1336 label: "Show instance features panel",
1339 "Enables panel displaying functionality of the instance on the About page"
1342 key: :showInstanceSpecificPanel,
1343 label: "Show instance specific panel",
1345 description: "Whether to show the instance's custom panel"
1348 key: :subjectLineBehavior,
1349 label: "Subject line behavior",
1351 description: "Allows changing the default behaviour of subject lines in replies.
1352 `email`: copy and preprend re:, as in email,
1353 `masto`: copy verbatim, as in Mastodon,
1354 `noop`: don't copy the subject.",
1355 suggestions: ["email", "masto", "noop"]
1360 description: "Which theme to use. Available themes are defined in styles.json",
1361 suggestions: ["pleroma-dark"]
1369 description: "Settings for Masto FE",
1372 showInstanceSpecificPanel: true
1377 key: :showInstanceSpecificPanel,
1378 label: "Show instance specific panel",
1380 description: "Whenether to show the instance's specific panel"
1391 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1395 type: {:keyword, :map},
1397 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1400 url: "/images/pleroma-fox-tan-smol.png",
1401 mime_type: "image/png"
1403 pleroma_fox_tan_shy: %{
1404 url: "/images/pleroma-fox-tan-shy.png",
1405 mime_type: "image/png"
1410 key: :default_mascot,
1413 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1419 key: :default_user_avatar,
1421 description: "URL of the default user avatar",
1422 suggestions: ["/images/avi.png"]
1431 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1435 type: {:list, :map},
1436 description: "Describe the icons of the app",
1439 src: "/static/logo.png"
1442 src: "/static/icon.png",
1446 src: "/static/icon.ico",
1447 sizes: "72x72 96x96 128x128 256x256"
1454 description: "Describe the theme color of the app",
1455 suggestions: ["#282c37", "mediumpurple"]
1458 key: :background_color,
1460 description: "Describe the background color of the app",
1461 suggestions: ["#191b22", "aliceblue"]
1471 description: "General MRF settings",
1475 type: [:module, {:list, :module}],
1477 "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.",
1478 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1482 label: "MRF transparency",
1485 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1488 key: :transparency_exclusions,
1489 label: "MRF transparency exclusions",
1490 type: {:list, :string},
1492 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1503 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1504 label: "MRF Simple",
1506 description: "Simple ingress policies",
1509 key: :media_removal,
1510 type: {:list, :string},
1511 description: "List of instances to strip media attachments from",
1512 suggestions: ["example.com", "*.example.com"]
1516 label: "Media NSFW",
1517 type: {:list, :string},
1518 description: "List of instances to tag all media as NSFW (sensitive) from",
1519 suggestions: ["example.com", "*.example.com"]
1522 key: :federated_timeline_removal,
1523 type: {:list, :string},
1525 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1526 suggestions: ["example.com", "*.example.com"]
1530 type: {:list, :string},
1531 description: "List of instances to reject activities from (except deletes)",
1532 suggestions: ["example.com", "*.example.com"]
1536 type: {:list, :string},
1537 description: "List of instances to only accept activities from (except deletes)",
1538 suggestions: ["example.com", "*.example.com"]
1541 key: :followers_only,
1542 type: {:list, :string},
1543 description: "Force posts from the given instances to be visible by followers only",
1544 suggestions: ["example.com", "*.example.com"]
1547 key: :report_removal,
1548 type: {:list, :string},
1549 description: "List of instances to reject reports from",
1550 suggestions: ["example.com", "*.example.com"]
1553 key: :avatar_removal,
1554 type: {:list, :string},
1555 description: "List of instances to strip avatars from",
1556 suggestions: ["example.com", "*.example.com"]
1559 key: :banner_removal,
1560 type: {:list, :string},
1561 description: "List of instances to strip banners from",
1562 suggestions: ["example.com", "*.example.com"]
1565 key: :reject_deletes,
1566 type: {:list, :string},
1567 description: "List of instances to reject deletions from",
1568 suggestions: ["example.com", "*.example.com"]
1574 key: :mrf_activity_expiration,
1576 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1577 label: "MRF Activity Expiration Policy",
1579 description: "Adds automatic expiration to all local activities",
1584 description: "Default global expiration time for all local activities (in days)",
1585 suggestions: [90, 365]
1593 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1594 label: "MRF Subchain",
1597 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1598 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1602 type: {:map, {:list, :string}},
1603 description: "Matches a series of regular expressions against the actor field",
1606 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1614 key: :mrf_rejectnonpublic,
1616 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1617 description: "RejectNonPublic drops posts with non-public visibility settings.",
1618 label: "MRF Reject Non Public",
1622 key: :allow_followersonly,
1623 label: "Allow followers-only",
1625 description: "Whether to allow followers-only posts"
1630 description: "Whether to allow direct messages"
1636 key: :mrf_hellthread,
1638 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1639 label: "MRF Hellthread",
1641 description: "Block messages with excessive user mentions",
1644 key: :delist_threshold,
1647 "Number of mentioned users after which the message gets removed from timelines and" <>
1648 "disables notifications. Set to 0 to disable.",
1652 key: :reject_threshold,
1655 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1664 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1665 label: "MRF Keyword",
1667 description: "Reject or Word-Replace messages with a keyword or regex",
1671 type: {:list, :string},
1673 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1674 suggestions: ["foo", ~r/foo/iu]
1677 key: :federated_timeline_removal,
1678 type: {:list, :string},
1680 "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.",
1681 suggestions: ["foo", ~r/foo/iu]
1685 type: {:list, :tuple},
1687 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1688 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1696 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1697 label: "MRF Mention",
1699 description: "Block messages which mention a specific user",
1703 type: {:list, :string},
1704 description: "A list of actors for which any post mentioning them will be dropped",
1705 suggestions: ["actor1", "actor2"]
1711 key: :mrf_vocabulary,
1713 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1714 label: "MRF Vocabulary",
1716 description: "Filter messages which belong to certain activity vocabularies",
1720 type: {:list, :string},
1722 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1723 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1727 type: {:list, :string},
1729 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1730 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1736 # key: :mrf_user_allowlist,
1738 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1741 # "The keys in this section are the domain names that the policy should apply to." <>
1742 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1744 # %{"example.org" => ["https://example.org/users/admin"]}
1752 description: "Media proxy",
1757 description: "Enables proxying of remote media to the instance's proxy"
1764 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1765 suggestions: ["https://example.com"]
1773 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1779 description: "Enables invalidate media cache"
1784 description: "Module which will be used to cache purge.",
1786 Pleroma.Web.MediaProxy.Invalidation.Script,
1787 Pleroma.Web.MediaProxy.Invalidation.Http
1794 label: "Proxy Options",
1796 description: "Options for Pleroma.ReverseProxy",
1798 redirect_on_failure: false,
1799 max_body_length: 25 * 1_048_576,
1801 follow_redirect: true,
1807 key: :redirect_on_failure,
1810 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1811 "Any error during body processing will not be redirected as the response is chunked."
1814 key: :max_body_length,
1817 "Limits the content length to be approximately the " <>
1818 "specified length. It is validated with the `content-length` header and also verified when proxying."
1824 description: "HTTP options",
1829 description: "Adapter specific options",
1834 label: "SSL Options",
1835 description: "SSL options for HTTP adapter",
1839 type: {:list, :atom},
1840 description: "List of TLS version to use",
1841 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1850 type: [:string, :tuple],
1851 description: "Proxy URL",
1852 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1860 type: {:list, :string},
1861 description: "List of hosts with scheme to bypass the mediaproxy",
1862 suggestions: ["http://example.com"]
1868 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1870 description: "HTTP invalidate settings",
1875 description: "HTTP method of request. Default: :purge"
1879 type: {:keyword, :string},
1880 description: "HTTP headers of request",
1881 suggestions: [{"x-refresh", 1}]
1886 description: "Request options",
1890 type: {:map, :string}
1898 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1900 description: "Script invalidate settings",
1905 description: "Path to shell script. Which will run purge cache.",
1906 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1914 description: "Gopher settings",
1919 description: "Enables the gopher interface"
1925 description: "IP address to bind to",
1926 suggestions: [{0, 0, 0, 0}]
1931 description: "Port to bind to",
1937 description: "Port advertised in URLs (optional, defaults to port)",
1945 label: "ActivityPub",
1947 description: "ActivityPub-related settings",
1950 key: :unfollow_blocked,
1952 description: "Whether blocks result in people getting unfollowed"
1955 key: :outgoing_blocks,
1957 description: "Whether to federate blocks to other instances"
1960 key: :sign_object_fetches,
1962 description: "Sign object fetches with HTTP signatures"
1965 key: :note_replies_output_limit,
1968 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1971 key: :follow_handshake_timeout,
1973 description: "Following handshake timeout",
1980 key: :http_security,
1981 label: "HTTP security",
1983 description: "HTTP security settings",
1988 description: "Whether the managed content security policy is enabled"
1994 description: "Whether to additionally send a Strict-Transport-Security header"
1998 label: "STS max age",
2000 description: "The maximum age for the Strict-Transport-Security header if sent",
2001 suggestions: [31_536_000]
2005 label: "CT max age",
2007 description: "The maximum age for the Expect-CT header if sent",
2008 suggestions: [2_592_000]
2011 key: :referrer_policy,
2013 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2014 suggestions: ["same-origin", "no-referrer"]
2018 label: "Report URI",
2020 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2021 suggestions: ["https://example.com/report-uri"]
2026 group: :web_push_encryption,
2027 key: :vapid_details,
2028 label: "Vapid Details",
2031 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2037 "A mailto link for the administrative contact." <>
2038 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2039 suggestions: ["mailto:moderators@pleroma.com"]
2044 description: "VAPID public key",
2045 suggestions: ["Public key"]
2050 description: "VAPID private key",
2051 suggestions: ["Private key"]
2057 key: Pleroma.Captcha,
2059 description: "Captcha-related settings",
2064 description: "Whether the captcha should be shown on registration"
2069 description: "The method/service to use for captcha",
2070 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2073 key: :seconds_valid,
2075 description: "The time in seconds for which the captcha is valid",
2082 key: Pleroma.Captcha.Kocaptcha,
2085 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2086 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2091 description: "The kocaptcha endpoint to use",
2092 suggestions: ["https://captcha.kotobank.ch"]
2098 label: "Pleroma Admin Token",
2101 "Allows setting a token that can be used to authenticate requests with admin privileges without a normal user account token. Append the `admin_token` parameter to requests to utilize it. (Please reconsider using HTTP Basic Auth or OAuth-based authentication if possible)",
2106 description: "Admin token",
2108 "Please use a high entropy string or UUID"
2118 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2120 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2121 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2122 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2123 (see https://github.com/sorentwo/oban/issues/52).
2128 type: {:dropdown, :atom},
2129 description: "Logs verbose mode",
2130 suggestions: [false, :error, :warn, :info, :debug]
2134 type: {:keyword, :integer},
2136 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2138 activity_expiration: 10,
2139 attachments_cleanup: 5,
2141 federator_incoming: 50,
2142 federator_outgoing: 50,
2144 scheduled_activities: 10,
2150 key: :activity_expiration,
2152 description: "Activity expiration queue",
2156 key: :attachments_cleanup,
2158 description: "Attachment deletion queue",
2164 description: "Background queue",
2168 key: :federator_incoming,
2170 description: "Incoming federation queue",
2174 key: :federator_outgoing,
2176 description: "Outgoing federation queue",
2182 description: "Email sender queue, see Pleroma.Emails.Mailer",
2186 key: :scheduled_activities,
2188 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2192 key: :transmogrifier,
2194 description: "Transmogrifier queue",
2200 description: "Web push notifications queue",
2207 type: {:list, :tuple},
2208 description: "Settings for cron background jobs",
2210 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2211 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2212 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2213 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2214 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2223 description: "Includes custom worker options not interpretable directly by `Oban`",
2227 type: {:keyword, :integer},
2228 description: "Max retry attempts for failed jobs, per `Oban` queue",
2230 federator_incoming: 5,
2231 federator_outgoing: 5
2238 key: Pleroma.Web.Metadata,
2240 description: "Metadata-related settings",
2244 type: {:list, :module},
2245 description: "List of metadata providers to enable",
2247 Pleroma.Web.Metadata.Providers.OpenGraph,
2248 Pleroma.Web.Metadata.Providers.TwitterCard,
2249 Pleroma.Web.Metadata.Providers.RelMe,
2250 Pleroma.Web.Metadata.Providers.Feed
2255 label: "Unfurl NSFW",
2257 description: "When enabled NSFW attachments will be shown in previews"
2266 "If enabled the instance will parse metadata from attached links to generate link previews",
2271 description: "Enables RichMedia parsing of URLs"
2275 type: {:list, :string},
2276 description: "List of hosts which will be ignored by the metadata parser",
2277 suggestions: ["accounts.google.com", "xss.website"]
2281 label: "Ignore TLD",
2282 type: {:list, :string},
2283 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2284 suggestions: ["local", "localdomain", "lan"]
2288 type: {:list, :module},
2290 "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.",
2292 Pleroma.Web.RichMedia.Parsers.OEmbed,
2293 Pleroma.Web.RichMedia.Parsers.TwitterCard
2298 label: "TTL setters",
2299 type: {:list, :module},
2301 "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.",
2303 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2310 key: Pleroma.Formatter,
2311 label: "Auto Linker",
2314 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2318 type: [:string, :boolean],
2319 description: "Specify the class to be added to the generated link. Disable to clear.",
2320 suggestions: ["auto-linker", false]
2324 type: [:string, :boolean],
2325 description: "Override the rel attribute. Disable to clear.",
2326 suggestions: ["ugc", "noopener noreferrer", false]
2331 description: "Link URLs will open in a new window/tab."
2335 type: [:integer, :boolean],
2337 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2338 suggestions: [15, false]
2343 description: "Strip the scheme prefix."
2348 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2352 type: [:atom, :boolean],
2354 "Set to false to disable TLD validation for URLs/emails. Can be set to :no_scheme to validate TLDs only for URLs without a scheme (e.g `example.com` will be validated, but `http://example.loki` won't)",
2355 suggestions: [:no_scheme, true]
2361 key: Pleroma.ScheduledActivity,
2363 description: "Scheduled activities settings",
2366 key: :daily_user_limit,
2369 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2373 key: :total_user_limit,
2376 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2382 description: "Whether scheduled activities are sent to the job queue to be executed"
2388 key: Pleroma.ActivityExpiration,
2390 description: "Expired activity settings",
2395 description: "Whether expired activities will be sent to the job queue to be deleted"
2401 label: "Pleroma Authenticator",
2403 description: "Authenticator",
2406 key: Pleroma.Web.Auth.Authenticator,
2408 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2418 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2419 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2420 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2421 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2426 description: "Enables LDAP authentication"
2431 description: "LDAP server hostname",
2432 suggestions: ["localhosts"]
2437 description: "LDAP port, e.g. 389 or 636",
2438 suggestions: [389, 636]
2444 description: "Enable to use SSL, usually implies the port 636"
2448 label: "SSL options",
2450 description: "Additional SSL options",
2451 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2456 description: "Path to file with PEM encoded cacerts",
2457 suggestions: ["path/to/file/with/PEM/cacerts"]
2462 description: "Type of cert verification",
2463 suggestions: [:verify_peer]
2471 description: "Enable to use STARTTLS, usually implies the port 389"
2475 label: "TLS options",
2477 description: "Additional TLS options",
2478 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2483 description: "Path to file with PEM encoded cacerts",
2484 suggestions: ["path/to/file/with/PEM/cacerts"]
2489 description: "Type of cert verification",
2490 suggestions: [:verify_peer]
2497 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2498 suggestions: ["dc=example,dc=com"]
2505 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2514 description: "Authentication / authorization settings",
2517 key: :enforce_oauth_admin_scope_usage,
2518 label: "Enforce OAuth admin scope usage",
2521 "OAuth admin scope requirement toggle. " <>
2522 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2523 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2524 "`is_admin` user flag grants access to admin-specific actions."
2527 key: :auth_template,
2530 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2531 suggestions: ["show.html"]
2534 key: :oauth_consumer_template,
2535 label: "OAuth consumer template",
2538 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2539 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2540 suggestions: ["consumer.html"]
2543 key: :oauth_consumer_strategies,
2544 label: "OAuth consumer strategies",
2545 type: {:list, :string},
2547 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2548 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2549 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2550 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2556 key: :email_notifications,
2558 description: "Email notifications settings",
2564 "emails of \"what you've missed\" for users who have been inactive for a while",
2568 schedule: "0 0 * * 0",
2570 inactivity_threshold: 7
2578 description: "Globally enable or disable digest emails"
2584 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2585 suggestions: ["0 0 * * 0"]
2590 description: "Minimum interval between digest emails to one user",
2594 key: :inactivity_threshold,
2596 description: "Minimum user inactivity threshold",
2605 key: Pleroma.Emails.UserEmail,
2607 description: "Email template settings",
2612 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2613 suggestions: ["some/path/logo.png"]
2618 description: "A map with color settings for email templates.",
2621 link_color: "#d8a070",
2622 background_color: "#2C3645",
2623 content_background_color: "#1B2635",
2624 header_color: "#d8a070",
2625 text_color: "#b9b9ba",
2626 text_muted_color: "#b9b9ba"
2633 suggestions: ["#d8a070"]
2636 key: :background_color,
2638 suggestions: ["#2C3645"]
2641 key: :content_background_color,
2643 suggestions: ["#1B2635"]
2648 suggestions: ["#d8a070"]
2653 suggestions: ["#b9b9ba"]
2656 key: :text_muted_color,
2658 suggestions: ["#b9b9ba"]
2666 key: Pleroma.Emails.NewUsersDigestEmail,
2668 description: "New users admin email digest",
2673 description: "Enables new users admin digest email when `true`"
2682 description: "Configure OAuth 2 provider capabilities",
2685 key: :token_expires_in,
2687 description: "The lifetime in seconds of the access token",
2691 key: :issue_new_refresh_token,
2694 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2697 key: :clean_expired_tokens,
2699 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2709 key: :shortcode_globs,
2710 type: {:list, :string},
2711 description: "Location of custom emoji files. * can be used as a wildcard.",
2712 suggestions: ["/emoji/custom/**/*.png"]
2715 key: :pack_extensions,
2716 type: {:list, :string},
2718 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2719 suggestions: [".png", ".gif"]
2723 type: {:keyword, {:list, :string}},
2725 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2726 " and the value is the location or array of locations. * can be used as a wildcard.",
2728 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2732 key: :default_manifest,
2735 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2736 " Currently only one manifest can be added (no arrays).",
2737 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2740 key: :shared_pack_cache_seconds_per_file,
2741 label: "Shared pack cache s/file",
2744 "When an emoji pack is shared, the archive is created and cached in memory" <>
2745 " for this amount of seconds multiplied by the number of files.",
2755 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2759 type: [:tuple, {:list, :tuple}],
2760 description: "For the search requests (account & status search etc.)",
2761 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2765 type: [:tuple, {:list, :tuple}],
2766 description: "For requests to timelines (each timeline has it's own limiter)",
2767 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2770 key: :app_account_creation,
2771 type: [:tuple, {:list, :tuple}],
2772 description: "For registering user accounts from the same IP address",
2773 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2776 key: :relations_actions,
2777 type: [:tuple, {:list, :tuple}],
2778 description: "For actions on relationships with all users (follow, unfollow)",
2779 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2782 key: :relation_id_action,
2783 label: "Relation ID action",
2784 type: [:tuple, {:list, :tuple}],
2785 description: "For actions on relation with a specific user (follow, unfollow)",
2786 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2789 key: :statuses_actions,
2790 type: [:tuple, {:list, :tuple}],
2792 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2793 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2796 key: :status_id_action,
2797 label: "Status ID action",
2798 type: [:tuple, {:list, :tuple}],
2800 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2801 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2804 key: :authentication,
2805 type: [:tuple, {:list, :tuple}],
2806 description: "For authentication create / password check / user existence check requests",
2807 suggestions: [{60_000, 15}]
2816 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2817 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2822 description: "Enables SSH"
2827 description: "Dir with SSH keys",
2828 suggestions: ["/some/path/ssh_keys"]
2833 description: "Handler module",
2834 suggestions: ["Pleroma.BBS.Handler"]
2839 description: "Port to connect",
2840 suggestions: [10_022]
2843 key: :password_authenticator,
2845 description: "Authenticator module",
2846 suggestions: ["Pleroma.BBS.Authenticator"]
2852 label: "Mime Types",
2854 description: "Mime Types settings",
2861 "application/xml" => ["xml"],
2862 "application/xrd+xml" => ["xrd+xml"],
2863 "application/jrd+json" => ["jrd+json"],
2864 "application/activity+json" => ["activity+json"],
2865 "application/ld+json" => ["activity+json"]
2870 key: "application/xml",
2871 type: {:list, :string},
2872 suggestions: ["xml"]
2875 key: "application/xrd+xml",
2876 type: {:list, :string},
2877 suggestions: ["xrd+xml"]
2880 key: "application/jrd+json",
2881 type: {:list, :string},
2882 suggestions: ["jrd+json"]
2885 key: "application/activity+json",
2886 type: {:list, :string},
2887 suggestions: ["activity+json"]
2890 key: "application/ld+json",
2891 type: {:list, :string},
2892 suggestions: ["activity+json"]
2902 description: "Pleroma chat settings",
2915 description: "HTTP settings",
2920 type: [:string, :tuple],
2921 description: "Proxy URL",
2922 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2925 key: :send_user_agent,
2930 type: [:string, :atom],
2932 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2933 suggestions: ["Pleroma", :default]
2938 description: "Adapter specific options",
2944 label: "SSL Options",
2945 description: "SSL options for HTTP adapter",
2949 type: {:list, :atom},
2950 description: "List of TLS version to use",
2951 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2962 label: "Markup Settings",
2966 key: :allow_inline_images,
2970 key: :allow_headings,
2983 type: {:list, :module},
2985 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2986 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2996 key: :deny_follow_blocked,
3003 key: :mrf_normalize_markup,
3005 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3006 label: "MRF Normalize Markup",
3007 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3013 suggestions: [Pleroma.HTML.Scrubber.Default]
3023 key: :restricted_nicknames,
3024 type: {:list, :string},
3043 "ostatus_subscribe",
3062 label: "CORS plug config",
3068 suggestions: [86_400]
3072 type: {:list, :string},
3073 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3077 type: {:list, :string},
3080 "X-RateLimit-Reset",
3081 "X-RateLimit-Limit",
3082 "X-RateLimit-Remaining",
3093 type: {:list, :string},
3094 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3100 key: Pleroma.Plugs.RemoteIp,
3103 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3104 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3110 description: "Enable/disable the plug. Default: disabled."
3114 type: {:list, :string},
3116 "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]`."
3120 type: {:list, :string},
3122 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3126 type: {:list, :string},
3128 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3134 key: :web_cache_ttl,
3135 label: "Web cache TTL",
3138 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3144 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3145 suggestions: [30_000, nil]
3148 key: :activity_pub_question,
3150 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3151 suggestions: [30_000]
3161 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3166 description: "Enables the rendering of static HTML. Default: disabled."
3174 description: "Configure feed rendering",
3179 description: "Configure title rendering",
3184 description: "Maximum number of characters before truncating title",
3190 description: "Replacement which will be used after truncating string",
3191 suggestions: ["..."]
3199 key: :mrf_object_age,
3201 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3202 label: "MRF Object Age",
3205 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3210 description: "Required age (in seconds) of a post before actions are taken.",
3211 suggestions: [172_800]
3215 type: {:list, :atom},
3217 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3218 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3219 "`:reject` rejects the message entirely",
3220 suggestions: [:delist, :strip_followers, :reject]
3228 description: "Custom Runtime Modules",
3233 description: "A path to custom Elixir modules (such as MRF policies)."
3241 description: "Settings for notifications streamer",
3246 description: "Number of workers to send notifications",
3250 key: :overflow_workers,
3252 description: "Maximum number of workers created if pool is empty",
3259 key: :connections_pool,
3261 description: "Advanced settings for `gun` connections pool",
3264 key: :connection_acquisition_wait,
3267 "Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries. Default: 250ms.",
3271 key: :connection_acquisition_retries,
3274 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3278 key: :max_connections,
3280 description: "Maximum number of connections in the pool. Default: 250 connections.",
3284 key: :await_up_timeout,
3286 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3290 key: :reclaim_multiplier,
3293 "Multiplier for the number of idle connection to be reclaimed if the pool is full. For example if the pool maxes out at 250 connections and this setting is set to 0.3, the pool will reclaim at most 75 idle connections if it's overloaded. Default: 0.1",
3302 description: "Advanced settings for `gun` workers pools",
3304 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3308 description: "Settings for #{pool_name} pool.",
3313 description: "Maximum number of concurrent requests in the pool.",
3320 "Maximum number of requests waiting for other requests to finish. After this number is reached, the pool will start returning errrors when a new request is made",
3329 key: :hackney_pools,
3331 description: "Advanced settings for `hackney` connections pools",
3336 description: "Settings for federation pool.",
3339 key: :max_connections,
3341 description: "Number workers in the pool.",
3347 description: "Timeout while `hackney` will wait for response.",
3348 suggestions: [150_000]
3355 description: "Settings for media pool.",
3358 key: :max_connections,
3360 description: "Number workers in the pool.",
3366 description: "Timeout while `hackney` will wait for response.",
3367 suggestions: [150_000]
3374 description: "Settings for upload pool.",
3377 key: :max_connections,
3379 description: "Number workers in the pool.",
3385 description: "Timeout while `hackney` will wait for response.",
3386 suggestions: [300_000]
3394 key: :restrict_unauthenticated,
3397 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3402 description: "Settings for public and federated timelines.",
3407 description: "Disallow view public timeline."
3412 description: "Disallow view federated timeline."
3419 description: "Settings for user profiles.",
3424 description: "Disallow view local user profiles."
3429 description: "Disallow view remote user profiles."
3436 description: "Settings for statuses.",
3441 description: "Disallow view local statuses."
3446 description: "Disallow view remote statuses."
3454 key: Pleroma.Web.ApiSpec.CastAndValidate,
3461 "Enables strict input validation (useful in development, not recommended in production)"
3467 key: :instances_favicons,
3469 description: "Control favicons for instances",
3474 description: "Allow/disallow displaying and getting instances favicons"
3482 descriptions: "S3 service related settings",
3485 key: :access_key_id,
3487 description: "S3 access key ID",
3488 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3491 key: :secret_access_key,
3493 description: "Secret access key",
3494 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3499 description: "S3 host",
3500 suggestions: ["s3.eu-central-1.amazonaws.com"]
3508 description: "Installed frontends management",
3513 description: "Primary frontend, the one that is served for all pages by default",
3518 description: "Name of the installed primary frontend"
3523 description: "reference of the installed primary frontend to be used"