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"]
960 key: :show_reactions,
962 description: "Let favourites and emoji reactions be viewed through the API."
969 description: "Welcome messages settings",
972 group: :direct_message,
974 descpiption: "Direct message settings",
979 description: "Enables sends direct message for new user after registration"
985 "A message that will be sent to a newly registered users as a direct message",
987 "Hi, @username! Welcome on board!"
991 key: :sender_nickname,
993 description: "The nickname of the local user that sends the welcome message",
1003 descpiption: "Email message settings",
1008 description: "Enables sends direct message for new user after registration"
1012 type: [:string, :tuple],
1014 "The email address or tuple with `{nickname, email}` that will use as sender to the welcome email.",
1016 {"Pleroma App", "welcome@pleroma.app"}
1023 "The subject of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1024 suggestions: ["Welcome to <%= instance_name%>"]
1030 "The html content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1031 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1037 "The text content of welcome email. Can be use EEX template with `user` and `instance_name` variables.",
1038 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1047 description: "Logger-related settings",
1051 type: [:atom, :tuple, :module],
1053 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1054 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1062 label: "ExSyslogger",
1063 description: "ExSyslogger-related settings",
1067 type: {:dropdown, :atom},
1068 description: "Log level",
1069 suggestions: [:debug, :info, :warn, :error]
1075 "A string that's prepended to every message, and is typically set to the app name",
1076 suggestions: ["pleroma"]
1081 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1082 suggestions: ["$metadata[$level] $message"]
1086 type: {:list, :atom},
1087 suggestions: [:request_id]
1095 label: "Console Logger",
1096 description: "Console logger settings",
1100 type: {:dropdown, :atom},
1101 description: "Log level",
1102 suggestions: [:debug, :info, :warn, :error]
1107 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1108 suggestions: ["$metadata[$level] $message"]
1112 type: {:list, :atom},
1113 suggestions: [:request_id]
1120 label: "Quack Logger",
1121 description: "Quack-related settings",
1125 type: {:dropdown, :atom},
1126 description: "Log level",
1127 suggestions: [:debug, :info, :warn, :error]
1131 type: {:list, :atom},
1132 description: "Configure which metadata you want to report on",
1149 label: "Webhook URL",
1151 description: "Configure the Slack incoming webhook",
1152 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1158 key: :frontend_configurations,
1161 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1162 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1163 "add your own configuration your settings all fields must be complete.",
1167 label: "Pleroma FE",
1169 description: "Settings for Pleroma FE",
1172 alwaysShowSubjectInput: true,
1173 background: "/static/aurora_borealis.jpg",
1174 collapseMessageWithSubject: false,
1177 hideFilteredStatuses: false,
1178 hideMutedPosts: false,
1179 hidePostStats: false,
1180 hideSitename: false,
1181 hideUserStats: false,
1182 loginMethod: "password",
1183 logo: "/static/logo.png",
1186 minimalScopesMode: false,
1187 noAttachmentLinks: false,
1188 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1189 postContentType: "text/plain",
1190 redirectRootLogin: "/main/friends",
1191 redirectRootNoLogin: "/main/all",
1193 sidebarRight: false,
1194 showFeaturesPanel: true,
1195 showInstanceSpecificPanel: false,
1196 subjectLineBehavior: "email",
1197 theme: "pleroma-dark",
1198 webPushNotifications: false
1203 key: :alwaysShowSubjectInput,
1204 label: "Always show subject input",
1206 description: "When disabled, auto-hide the subject field if it's empty"
1212 "URL of the background, unless viewing a user profile with a background that is set",
1213 suggestions: ["/images/city.jpg"]
1216 key: :collapseMessageWithSubject,
1217 label: "Collapse message with subject",
1220 "When a message has a subject (aka Content Warning), collapse it by default"
1224 label: "PleromaFE Chat",
1226 description: "Disables PleromaFE Chat component"
1232 description: "Enables green text on lines prefixed with the > character"
1235 key: :hideFilteredStatuses,
1236 label: "Hide Filtered Statuses",
1238 description: "Hides filtered statuses from timelines"
1241 key: :hideMutedPosts,
1242 label: "Hide Muted Posts",
1244 description: "Hides muted statuses from timelines"
1247 key: :hidePostStats,
1248 label: "Hide post stats",
1250 description: "Hide notices statistics (repeats, favorites, ...)"
1254 label: "Hide Sitename",
1256 description: "Hides instance name from PleromaFE banner"
1259 key: :hideUserStats,
1260 label: "Hide user stats",
1263 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1268 description: "URL of the logo, defaults to Pleroma's logo",
1269 suggestions: ["/static/logo.png"]
1273 label: "Logo margin",
1276 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1277 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1278 suggestions: [".1em"]
1285 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1286 "If you want a colorful logo you must disable logoMask."
1289 key: :minimalScopesMode,
1290 label: "Minimal scopes mode",
1293 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1294 "Also prevents replying to a DM with a public post from PleromaFE."
1297 key: :nsfwCensorImage,
1298 label: "NSFW Censor Image",
1301 "URL of the image to use for hiding NSFW media attachments in the timeline",
1302 suggestions: ["/static/img/nsfw.74818f9.png"]
1305 key: :postContentType,
1306 label: "Post Content Type",
1307 type: {:dropdown, :atom},
1308 description: "Default post formatting option",
1309 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1312 key: :redirectRootNoLogin,
1313 label: "Redirect root no login",
1316 "Relative URL which indicates where to redirect when a user isn't logged in",
1317 suggestions: ["/main/all"]
1320 key: :redirectRootLogin,
1321 label: "Redirect root login",
1324 "Relative URL which indicates where to redirect when a user is logged in",
1325 suggestions: ["/main/friends"]
1329 label: "Scope copy",
1331 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1335 label: "Sidebar on Right",
1337 description: "Change alignment of sidebar and panels to the right"
1340 key: :showFeaturesPanel,
1341 label: "Show instance features panel",
1344 "Enables panel displaying functionality of the instance on the About page"
1347 key: :showInstanceSpecificPanel,
1348 label: "Show instance specific panel",
1350 description: "Whether to show the instance's custom panel"
1353 key: :subjectLineBehavior,
1354 label: "Subject line behavior",
1356 description: "Allows changing the default behaviour of subject lines in replies.
1357 `email`: copy and preprend re:, as in email,
1358 `masto`: copy verbatim, as in Mastodon,
1359 `noop`: don't copy the subject.",
1360 suggestions: ["email", "masto", "noop"]
1365 description: "Which theme to use. Available themes are defined in styles.json",
1366 suggestions: ["pleroma-dark"]
1374 description: "Settings for Masto FE",
1377 showInstanceSpecificPanel: true
1382 key: :showInstanceSpecificPanel,
1383 label: "Show instance specific panel",
1385 description: "Whenether to show the instance's specific panel"
1396 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1400 type: {:keyword, :map},
1402 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1405 url: "/images/pleroma-fox-tan-smol.png",
1406 mime_type: "image/png"
1408 pleroma_fox_tan_shy: %{
1409 url: "/images/pleroma-fox-tan-shy.png",
1410 mime_type: "image/png"
1415 key: :default_mascot,
1418 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1424 key: :default_user_avatar,
1426 description: "URL of the default user avatar",
1427 suggestions: ["/images/avi.png"]
1436 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1440 type: {:list, :map},
1441 description: "Describe the icons of the app",
1444 src: "/static/logo.png"
1447 src: "/static/icon.png",
1451 src: "/static/icon.ico",
1452 sizes: "72x72 96x96 128x128 256x256"
1459 description: "Describe the theme color of the app",
1460 suggestions: ["#282c37", "mediumpurple"]
1463 key: :background_color,
1465 description: "Describe the background color of the app",
1466 suggestions: ["#191b22", "aliceblue"]
1476 description: "General MRF settings",
1480 type: [:module, {:list, :module}],
1482 "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.",
1483 suggestions: {:list_behaviour_implementations, Pleroma.Web.ActivityPub.MRF}
1487 label: "MRF transparency",
1490 "Make the content of your Message Rewrite Facility settings public (via nodeinfo)"
1493 key: :transparency_exclusions,
1494 label: "MRF transparency exclusions",
1495 type: {:list, :string},
1497 "Exclude specific instance names from MRF transparency. The use of the exclusions feature will be disclosed in nodeinfo as a boolean value.",
1508 related_policy: "Pleroma.Web.ActivityPub.MRF.SimplePolicy",
1509 label: "MRF Simple",
1511 description: "Simple ingress policies",
1514 key: :media_removal,
1515 type: {:list, :string},
1516 description: "List of instances to strip media attachments from",
1517 suggestions: ["example.com", "*.example.com"]
1521 label: "Media NSFW",
1522 type: {:list, :string},
1523 description: "List of instances to tag all media as NSFW (sensitive) from",
1524 suggestions: ["example.com", "*.example.com"]
1527 key: :federated_timeline_removal,
1528 type: {:list, :string},
1530 "List of instances to remove from the Federated (aka The Whole Known Network) Timeline",
1531 suggestions: ["example.com", "*.example.com"]
1535 type: {:list, :string},
1536 description: "List of instances to reject activities from (except deletes)",
1537 suggestions: ["example.com", "*.example.com"]
1541 type: {:list, :string},
1542 description: "List of instances to only accept activities from (except deletes)",
1543 suggestions: ["example.com", "*.example.com"]
1546 key: :report_removal,
1547 type: {:list, :string},
1548 description: "List of instances to reject reports from",
1549 suggestions: ["example.com", "*.example.com"]
1552 key: :avatar_removal,
1553 type: {:list, :string},
1554 description: "List of instances to strip avatars from",
1555 suggestions: ["example.com", "*.example.com"]
1558 key: :banner_removal,
1559 type: {:list, :string},
1560 description: "List of instances to strip banners from",
1561 suggestions: ["example.com", "*.example.com"]
1564 key: :reject_deletes,
1565 type: {:list, :string},
1566 description: "List of instances to reject deletions from",
1567 suggestions: ["example.com", "*.example.com"]
1573 key: :mrf_activity_expiration,
1575 related_policy: "Pleroma.Web.ActivityPub.MRF.ActivityExpirationPolicy",
1576 label: "MRF Activity Expiration Policy",
1578 description: "Adds automatic expiration to all local activities",
1583 description: "Default global expiration time for all local activities (in days)",
1584 suggestions: [90, 365]
1592 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1593 label: "MRF Subchain",
1596 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1597 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1601 type: {:map, {:list, :string}},
1602 description: "Matches a series of regular expressions against the actor field",
1605 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1613 key: :mrf_rejectnonpublic,
1615 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1616 description: "RejectNonPublic drops posts with non-public visibility settings.",
1617 label: "MRF Reject Non Public",
1621 key: :allow_followersonly,
1622 label: "Allow followers-only",
1624 description: "Whether to allow followers-only posts"
1629 description: "Whether to allow direct messages"
1635 key: :mrf_hellthread,
1637 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1638 label: "MRF Hellthread",
1640 description: "Block messages with excessive user mentions",
1643 key: :delist_threshold,
1646 "Number of mentioned users after which the message gets removed from timelines and" <>
1647 "disables notifications. Set to 0 to disable.",
1651 key: :reject_threshold,
1654 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1663 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1664 label: "MRF Keyword",
1666 description: "Reject or Word-Replace messages with a keyword or regex",
1670 type: {:list, :string},
1672 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1673 suggestions: ["foo", ~r/foo/iu]
1676 key: :federated_timeline_removal,
1677 type: {:list, :string},
1679 "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.",
1680 suggestions: ["foo", ~r/foo/iu]
1684 type: {:list, :tuple},
1686 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1687 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1695 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1696 label: "MRF Mention",
1698 description: "Block messages which mention a specific user",
1702 type: {:list, :string},
1703 description: "A list of actors for which any post mentioning them will be dropped",
1704 suggestions: ["actor1", "actor2"]
1710 key: :mrf_vocabulary,
1712 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1713 label: "MRF Vocabulary",
1715 description: "Filter messages which belong to certain activity vocabularies",
1719 type: {:list, :string},
1721 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1722 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1726 type: {:list, :string},
1728 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1729 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1735 # key: :mrf_user_allowlist,
1737 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1740 # "The keys in this section are the domain names that the policy should apply to." <>
1741 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1743 # %{"example.org" => ["https://example.org/users/admin"]}
1751 description: "Media proxy",
1756 description: "Enables proxying of remote media to the instance's proxy"
1763 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1764 suggestions: ["https://example.com"]
1772 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1778 description: "Enables invalidate media cache"
1783 description: "Module which will be used to cache purge.",
1785 Pleroma.Web.MediaProxy.Invalidation.Script,
1786 Pleroma.Web.MediaProxy.Invalidation.Http
1793 label: "Proxy Options",
1795 description: "Options for Pleroma.ReverseProxy",
1797 redirect_on_failure: false,
1798 max_body_length: 25 * 1_048_576,
1800 follow_redirect: true,
1806 key: :redirect_on_failure,
1809 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1810 "Any error during body processing will not be redirected as the response is chunked."
1813 key: :max_body_length,
1816 "Limits the content length to be approximately the " <>
1817 "specified length. It is validated with the `content-length` header and also verified when proxying."
1823 description: "HTTP options",
1828 description: "Adapter specific options",
1833 label: "SSL Options",
1834 description: "SSL options for HTTP adapter",
1838 type: {:list, :atom},
1839 description: "List of TLS version to use",
1840 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1849 type: [:string, :tuple],
1850 description: "Proxy URL",
1851 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1859 type: {:list, :string},
1860 description: "List of hosts with scheme to bypass the mediaproxy",
1861 suggestions: ["http://example.com"]
1867 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1869 description: "HTTP invalidate settings",
1874 description: "HTTP method of request. Default: :purge"
1878 type: {:keyword, :string},
1879 description: "HTTP headers of request",
1880 suggestions: [{"x-refresh", 1}]
1885 description: "Request options",
1889 type: {:map, :string}
1897 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1899 description: "Script invalidate settings",
1904 description: "Path to shell script. Which will run purge cache.",
1905 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1913 description: "Gopher settings",
1918 description: "Enables the gopher interface"
1924 description: "IP address to bind to",
1925 suggestions: [{0, 0, 0, 0}]
1930 description: "Port to bind to",
1936 description: "Port advertised in URLs (optional, defaults to port)",
1944 label: "ActivityPub",
1946 description: "ActivityPub-related settings",
1949 key: :unfollow_blocked,
1951 description: "Whether blocks result in people getting unfollowed"
1954 key: :outgoing_blocks,
1956 description: "Whether to federate blocks to other instances"
1959 key: :sign_object_fetches,
1961 description: "Sign object fetches with HTTP signatures"
1964 key: :note_replies_output_limit,
1967 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1970 key: :follow_handshake_timeout,
1972 description: "Following handshake timeout",
1979 key: :http_security,
1980 label: "HTTP security",
1982 description: "HTTP security settings",
1987 description: "Whether the managed content security policy is enabled"
1993 description: "Whether to additionally send a Strict-Transport-Security header"
1997 label: "STS max age",
1999 description: "The maximum age for the Strict-Transport-Security header if sent",
2000 suggestions: [31_536_000]
2004 label: "CT max age",
2006 description: "The maximum age for the Expect-CT header if sent",
2007 suggestions: [2_592_000]
2010 key: :referrer_policy,
2012 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2013 suggestions: ["same-origin", "no-referrer"]
2017 label: "Report URI",
2019 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2020 suggestions: ["https://example.com/report-uri"]
2025 group: :web_push_encryption,
2026 key: :vapid_details,
2027 label: "Vapid Details",
2030 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2036 "A mailto link for the administrative contact." <>
2037 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2038 suggestions: ["mailto:moderators@pleroma.com"]
2043 description: "VAPID public key",
2044 suggestions: ["Public key"]
2049 description: "VAPID private key",
2050 suggestions: ["Private key"]
2056 key: Pleroma.Captcha,
2058 description: "Captcha-related settings",
2063 description: "Whether the captcha should be shown on registration"
2068 description: "The method/service to use for captcha",
2069 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2072 key: :seconds_valid,
2074 description: "The time in seconds for which the captcha is valid",
2081 key: Pleroma.Captcha.Kocaptcha,
2084 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2085 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2090 description: "The kocaptcha endpoint to use",
2091 suggestions: ["https://captcha.kotobank.ch"]
2097 label: "Pleroma Admin Token",
2100 "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)",
2105 description: "Admin token",
2107 "Please use a high entropy string or UUID"
2117 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2119 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2120 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2121 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2122 (see https://github.com/sorentwo/oban/issues/52).
2127 type: {:dropdown, :atom},
2128 description: "Logs verbose mode",
2129 suggestions: [false, :error, :warn, :info, :debug]
2133 type: {:keyword, :integer},
2135 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2137 activity_expiration: 10,
2138 attachments_cleanup: 5,
2140 federator_incoming: 50,
2141 federator_outgoing: 50,
2143 scheduled_activities: 10,
2149 key: :activity_expiration,
2151 description: "Activity expiration queue",
2155 key: :attachments_cleanup,
2157 description: "Attachment deletion queue",
2163 description: "Background queue",
2167 key: :federator_incoming,
2169 description: "Incoming federation queue",
2173 key: :federator_outgoing,
2175 description: "Outgoing federation queue",
2181 description: "Email sender queue, see Pleroma.Emails.Mailer",
2185 key: :scheduled_activities,
2187 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2191 key: :transmogrifier,
2193 description: "Transmogrifier queue",
2199 description: "Web push notifications queue",
2206 type: {:list, :tuple},
2207 description: "Settings for cron background jobs",
2209 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2210 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2211 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2212 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2213 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2222 description: "Includes custom worker options not interpretable directly by `Oban`",
2226 type: {:keyword, :integer},
2227 description: "Max retry attempts for failed jobs, per `Oban` queue",
2229 federator_incoming: 5,
2230 federator_outgoing: 5
2237 key: Pleroma.Web.Metadata,
2239 description: "Metadata-related settings",
2243 type: {:list, :module},
2244 description: "List of metadata providers to enable",
2246 Pleroma.Web.Metadata.Providers.OpenGraph,
2247 Pleroma.Web.Metadata.Providers.TwitterCard,
2248 Pleroma.Web.Metadata.Providers.RelMe,
2249 Pleroma.Web.Metadata.Providers.Feed
2254 label: "Unfurl NSFW",
2256 description: "When enabled NSFW attachments will be shown in previews"
2265 "If enabled the instance will parse metadata from attached links to generate link previews",
2270 description: "Enables RichMedia parsing of URLs"
2274 type: {:list, :string},
2275 description: "List of hosts which will be ignored by the metadata parser",
2276 suggestions: ["accounts.google.com", "xss.website"]
2280 label: "Ignore TLD",
2281 type: {:list, :string},
2282 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2283 suggestions: ["local", "localdomain", "lan"]
2287 type: {:list, :module},
2289 "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.",
2291 Pleroma.Web.RichMedia.Parsers.OEmbed,
2292 Pleroma.Web.RichMedia.Parsers.TwitterCard
2297 label: "TTL setters",
2298 type: {:list, :module},
2300 "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.",
2302 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2309 key: Pleroma.Formatter,
2310 label: "Auto Linker",
2313 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2317 type: [:string, :boolean],
2318 description: "Specify the class to be added to the generated link. Disable to clear.",
2319 suggestions: ["auto-linker", false]
2323 type: [:string, :boolean],
2324 description: "Override the rel attribute. Disable to clear.",
2325 suggestions: ["ugc", "noopener noreferrer", false]
2330 description: "Link URLs will open in a new window/tab."
2334 type: [:integer, :boolean],
2336 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2337 suggestions: [15, false]
2342 description: "Strip the scheme prefix."
2347 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2351 type: [:atom, :boolean],
2353 "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)",
2354 suggestions: [:no_scheme, true]
2360 key: Pleroma.ScheduledActivity,
2362 description: "Scheduled activities settings",
2365 key: :daily_user_limit,
2368 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2372 key: :total_user_limit,
2375 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2381 description: "Whether scheduled activities are sent to the job queue to be executed"
2387 key: Pleroma.ActivityExpiration,
2389 description: "Expired activity settings",
2394 description: "Whether expired activities will be sent to the job queue to be deleted"
2400 label: "Pleroma Authenticator",
2402 description: "Authenticator",
2405 key: Pleroma.Web.Auth.Authenticator,
2407 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2417 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2418 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2419 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2420 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2425 description: "Enables LDAP authentication"
2430 description: "LDAP server hostname",
2431 suggestions: ["localhosts"]
2436 description: "LDAP port, e.g. 389 or 636",
2437 suggestions: [389, 636]
2443 description: "Enable to use SSL, usually implies the port 636"
2447 label: "SSL options",
2449 description: "Additional SSL options",
2450 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2455 description: "Path to file with PEM encoded cacerts",
2456 suggestions: ["path/to/file/with/PEM/cacerts"]
2461 description: "Type of cert verification",
2462 suggestions: [:verify_peer]
2470 description: "Enable to use STARTTLS, usually implies the port 389"
2474 label: "TLS options",
2476 description: "Additional TLS options",
2477 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2482 description: "Path to file with PEM encoded cacerts",
2483 suggestions: ["path/to/file/with/PEM/cacerts"]
2488 description: "Type of cert verification",
2489 suggestions: [:verify_peer]
2496 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2497 suggestions: ["dc=example,dc=com"]
2504 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2513 description: "Authentication / authorization settings",
2516 key: :enforce_oauth_admin_scope_usage,
2517 label: "Enforce OAuth admin scope usage",
2520 "OAuth admin scope requirement toggle. " <>
2521 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2522 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2523 "`is_admin` user flag grants access to admin-specific actions."
2526 key: :auth_template,
2529 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2530 suggestions: ["show.html"]
2533 key: :oauth_consumer_template,
2534 label: "OAuth consumer template",
2537 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2538 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2539 suggestions: ["consumer.html"]
2542 key: :oauth_consumer_strategies,
2543 label: "OAuth consumer strategies",
2544 type: {:list, :string},
2546 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2547 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2548 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2549 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2555 key: :email_notifications,
2557 description: "Email notifications settings",
2563 "emails of \"what you've missed\" for users who have been inactive for a while",
2567 schedule: "0 0 * * 0",
2569 inactivity_threshold: 7
2577 description: "Globally enable or disable digest emails"
2583 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2584 suggestions: ["0 0 * * 0"]
2589 description: "Minimum interval between digest emails to one user",
2593 key: :inactivity_threshold,
2595 description: "Minimum user inactivity threshold",
2604 key: Pleroma.Emails.UserEmail,
2606 description: "Email template settings",
2611 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2612 suggestions: ["some/path/logo.png"]
2617 description: "A map with color settings for email templates.",
2620 link_color: "#d8a070",
2621 background_color: "#2C3645",
2622 content_background_color: "#1B2635",
2623 header_color: "#d8a070",
2624 text_color: "#b9b9ba",
2625 text_muted_color: "#b9b9ba"
2632 suggestions: ["#d8a070"]
2635 key: :background_color,
2637 suggestions: ["#2C3645"]
2640 key: :content_background_color,
2642 suggestions: ["#1B2635"]
2647 suggestions: ["#d8a070"]
2652 suggestions: ["#b9b9ba"]
2655 key: :text_muted_color,
2657 suggestions: ["#b9b9ba"]
2665 key: Pleroma.Emails.NewUsersDigestEmail,
2667 description: "New users admin email digest",
2672 description: "Enables new users admin digest email when `true`"
2681 description: "Configure OAuth 2 provider capabilities",
2684 key: :token_expires_in,
2686 description: "The lifetime in seconds of the access token",
2690 key: :issue_new_refresh_token,
2693 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2696 key: :clean_expired_tokens,
2698 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2708 key: :shortcode_globs,
2709 type: {:list, :string},
2710 description: "Location of custom emoji files. * can be used as a wildcard.",
2711 suggestions: ["/emoji/custom/**/*.png"]
2714 key: :pack_extensions,
2715 type: {:list, :string},
2717 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2718 suggestions: [".png", ".gif"]
2722 type: {:keyword, {:list, :string}},
2724 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2725 " and the value is the location or array of locations. * can be used as a wildcard.",
2727 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2731 key: :default_manifest,
2734 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2735 " Currently only one manifest can be added (no arrays).",
2736 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2739 key: :shared_pack_cache_seconds_per_file,
2740 label: "Shared pack cache s/file",
2743 "When an emoji pack is shared, the archive is created and cached in memory" <>
2744 " for this amount of seconds multiplied by the number of files.",
2754 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2758 type: [:tuple, {:list, :tuple}],
2759 description: "For the search requests (account & status search etc.)",
2760 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2764 type: [:tuple, {:list, :tuple}],
2765 description: "For requests to timelines (each timeline has it's own limiter)",
2766 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2769 key: :app_account_creation,
2770 type: [:tuple, {:list, :tuple}],
2771 description: "For registering user accounts from the same IP address",
2772 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2775 key: :relations_actions,
2776 type: [:tuple, {:list, :tuple}],
2777 description: "For actions on relationships with all users (follow, unfollow)",
2778 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2781 key: :relation_id_action,
2782 label: "Relation ID action",
2783 type: [:tuple, {:list, :tuple}],
2784 description: "For actions on relation with a specific user (follow, unfollow)",
2785 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2788 key: :statuses_actions,
2789 type: [:tuple, {:list, :tuple}],
2791 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2792 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2795 key: :status_id_action,
2796 label: "Status ID action",
2797 type: [:tuple, {:list, :tuple}],
2799 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2800 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2803 key: :authentication,
2804 type: [:tuple, {:list, :tuple}],
2805 description: "For authentication create / password check / user existence check requests",
2806 suggestions: [{60_000, 15}]
2815 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2816 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2821 description: "Enables SSH"
2826 description: "Dir with SSH keys",
2827 suggestions: ["/some/path/ssh_keys"]
2832 description: "Handler module",
2833 suggestions: ["Pleroma.BBS.Handler"]
2838 description: "Port to connect",
2839 suggestions: [10_022]
2842 key: :password_authenticator,
2844 description: "Authenticator module",
2845 suggestions: ["Pleroma.BBS.Authenticator"]
2851 label: "Mime Types",
2853 description: "Mime Types settings",
2860 "application/xml" => ["xml"],
2861 "application/xrd+xml" => ["xrd+xml"],
2862 "application/jrd+json" => ["jrd+json"],
2863 "application/activity+json" => ["activity+json"],
2864 "application/ld+json" => ["activity+json"]
2869 key: "application/xml",
2870 type: {:list, :string},
2871 suggestions: ["xml"]
2874 key: "application/xrd+xml",
2875 type: {:list, :string},
2876 suggestions: ["xrd+xml"]
2879 key: "application/jrd+json",
2880 type: {:list, :string},
2881 suggestions: ["jrd+json"]
2884 key: "application/activity+json",
2885 type: {:list, :string},
2886 suggestions: ["activity+json"]
2889 key: "application/ld+json",
2890 type: {:list, :string},
2891 suggestions: ["activity+json"]
2901 description: "Pleroma chat settings",
2914 description: "HTTP settings",
2919 type: [:string, :tuple],
2920 description: "Proxy URL",
2921 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2924 key: :send_user_agent,
2929 type: [:string, :atom],
2931 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2932 suggestions: ["Pleroma", :default]
2937 description: "Adapter specific options",
2943 label: "SSL Options",
2944 description: "SSL options for HTTP adapter",
2948 type: {:list, :atom},
2949 description: "List of TLS version to use",
2950 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2961 label: "Markup Settings",
2965 key: :allow_inline_images,
2969 key: :allow_headings,
2982 type: {:list, :module},
2984 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2985 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2995 key: :deny_follow_blocked,
3002 key: :mrf_normalize_markup,
3004 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3005 label: "MRF Normalize Markup",
3006 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3012 suggestions: [Pleroma.HTML.Scrubber.Default]
3022 key: :restricted_nicknames,
3023 type: {:list, :string},
3042 "ostatus_subscribe",
3061 label: "CORS plug config",
3067 suggestions: [86_400]
3071 type: {:list, :string},
3072 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3076 type: {:list, :string},
3079 "X-RateLimit-Reset",
3080 "X-RateLimit-Limit",
3081 "X-RateLimit-Remaining",
3092 type: {:list, :string},
3093 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3099 key: Pleroma.Plugs.RemoteIp,
3102 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3103 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3109 description: "Enable/disable the plug. Default: disabled."
3113 type: {:list, :string},
3115 "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]`."
3119 type: {:list, :string},
3121 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3125 type: {:list, :string},
3127 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3133 key: :web_cache_ttl,
3134 label: "Web cache TTL",
3137 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3143 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3144 suggestions: [30_000, nil]
3147 key: :activity_pub_question,
3149 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3150 suggestions: [30_000]
3160 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3165 description: "Enables the rendering of static HTML. Default: disabled."
3173 description: "Configure feed rendering",
3178 description: "Configure title rendering",
3183 description: "Maximum number of characters before truncating title",
3189 description: "Replacement which will be used after truncating string",
3190 suggestions: ["..."]
3198 key: :mrf_object_age,
3200 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3201 label: "MRF Object Age",
3204 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3209 description: "Required age (in seconds) of a post before actions are taken.",
3210 suggestions: [172_800]
3214 type: {:list, :atom},
3216 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3217 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3218 "`:reject` rejects the message entirely",
3219 suggestions: [:delist, :strip_followers, :reject]
3227 description: "Custom Runtime Modules",
3232 description: "A path to custom Elixir modules (such as MRF policies)."
3240 description: "Settings for notifications streamer",
3245 description: "Number of workers to send notifications",
3249 key: :overflow_workers,
3251 description: "Maximum number of workers created if pool is empty",
3258 key: :connections_pool,
3260 description: "Advanced settings for `gun` connections pool",
3263 key: :connection_acquisition_wait,
3266 "Timeout to acquire a connection from pool.The total max time is this value multiplied by the number of retries. Default: 250ms.",
3270 key: :connection_acquisition_retries,
3273 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3277 key: :max_connections,
3279 description: "Maximum number of connections in the pool. Default: 250 connections.",
3283 key: :await_up_timeout,
3285 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3289 key: :reclaim_multiplier,
3292 "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",
3301 description: "Advanced settings for `gun` workers pools",
3303 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3307 description: "Settings for #{pool_name} pool.",
3312 description: "Maximum number of concurrent requests in the pool.",
3319 "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",
3328 key: :hackney_pools,
3330 description: "Advanced settings for `hackney` connections pools",
3335 description: "Settings for federation pool.",
3338 key: :max_connections,
3340 description: "Number workers in the pool.",
3346 description: "Timeout while `hackney` will wait for response.",
3347 suggestions: [150_000]
3354 description: "Settings for media pool.",
3357 key: :max_connections,
3359 description: "Number workers in the pool.",
3365 description: "Timeout while `hackney` will wait for response.",
3366 suggestions: [150_000]
3373 description: "Settings for upload pool.",
3376 key: :max_connections,
3378 description: "Number workers in the pool.",
3384 description: "Timeout while `hackney` will wait for response.",
3385 suggestions: [300_000]
3393 key: :restrict_unauthenticated,
3396 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3401 description: "Settings for public and federated timelines.",
3406 description: "Disallow view public timeline."
3411 description: "Disallow view federated timeline."
3418 description: "Settings for user profiles.",
3423 description: "Disallow view local user profiles."
3428 description: "Disallow view remote user profiles."
3435 description: "Settings for statuses.",
3440 description: "Disallow view local statuses."
3445 description: "Disallow view remote statuses."
3453 key: Pleroma.Web.ApiSpec.CastAndValidate,
3460 "Enables strict input validation (useful in development, not recommended in production)"
3466 key: :instances_favicons,
3468 description: "Control favicons for instances",
3473 description: "Allow/disallow displaying and getting instances favicons"
3481 descriptions: "S3 service related settings",
3484 key: :access_key_id,
3486 description: "S3 access key ID",
3487 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3490 key: :secret_access_key,
3492 description: "Secret access key",
3493 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3498 description: "S3 host",
3499 suggestions: ["s3.eu-central-1.amazonaws.com"]
3507 description: "Installed frontends management",
3512 description: "Primary frontend, the one that is served for all pages by default",
3517 description: "Name of the installed primary frontend"
3522 description: "reference of the installed primary frontend to be used"