6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
14 installed_frontend_options = [
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
36 description: "Name of the frontend."
42 description: "Reference of the frontend to be used."
46 label: "Git Repository URL",
48 description: "URL of the git repository of the frontend"
55 "Either an url to a zip file containing the frontend or a template to build it by inserting the `ref`. The string `${ref}` will be replaced by the configured `ref`.",
56 example: "https://some.url/builds/${ref}.zip"
60 label: "Build directory",
62 description: "The directory inside the zip file "
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
72 config :pleroma, :config_description, [
77 description: "Upload general settings",
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
87 type: {:list, :module},
89 "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.",
90 suggestions: {:list_behaviour_implementations, Pleroma.Upload.Filter}
96 "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`."
102 description: "Base URL for the uploads, needed if you use CDN",
104 "https://cdn-host.com"
111 Proxy requests to the remote uploader.\n
112 Useful if media upload endpoint is not internet accessible.
116 key: :filename_display_max_length,
118 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
124 key: Pleroma.Uploaders.Local,
126 description: "Local uploader-related settings",
131 description: "Path where user's uploads will be saved",
140 key: Pleroma.Uploaders.S3,
142 description: "S3 uploader-related settings",
147 description: "S3 bucket",
153 key: :bucket_namespace,
155 description: "S3 bucket namespace",
156 suggestions: ["pleroma"]
159 key: :truncated_namespace,
162 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
163 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
166 key: :streaming_enabled,
169 "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."
175 key: Pleroma.Upload.Filter.Mogrify,
177 description: "Uploads mogrify filter settings",
181 type: [:string, {:list, :string}, {:list, :tuple}],
183 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
184 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
195 key: Pleroma.Upload.Filter.AnonymizeFilename,
197 description: "Filter replaces the filename of the upload",
203 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
204 " filename extension by using {extension}, for example custom-file-name.{extension}.",
206 "custom-file-name.{extension}"
213 key: Pleroma.Emails.Mailer,
215 description: "Mailer-related settings",
221 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
223 Swoosh.Adapters.SMTP,
224 Swoosh.Adapters.Sendgrid,
225 Swoosh.Adapters.Sendmail,
226 Swoosh.Adapters.Mandrill,
227 Swoosh.Adapters.Mailgun,
228 Swoosh.Adapters.Mailjet,
229 Swoosh.Adapters.Postmark,
230 Swoosh.Adapters.SparkPost,
231 Swoosh.Adapters.AmazonSES,
233 Swoosh.Adapters.SocketLabs,
234 Swoosh.Adapters.Gmail
240 description: "Allow/disallow send emails"
243 group: {:subgroup, Swoosh.Adapters.SMTP},
246 description: "Hostname or IP address",
247 suggestions: ["smtp.example.com"]
250 group: {:subgroup, Swoosh.Adapters.SMTP},
253 description: "SMTP port"
256 group: {:subgroup, Swoosh.Adapters.SMTP},
259 description: "SMTP auth username",
260 suggestions: ["user@example.com"]
263 group: {:subgroup, Swoosh.Adapters.SMTP},
266 description: "SMTP auth password",
267 suggestions: ["password"]
270 group: {:subgroup, Swoosh.Adapters.SMTP},
274 description: "Use implicit SSL/TLS: e.g., port 465"
277 group: {:subgroup, Swoosh.Adapters.SMTP},
280 type: {:dropdown, :atom},
281 description: "Explicit TLS (STARTTLS) mode",
282 suggestions: [:if_available, :always, :never]
285 group: {:subgroup, Swoosh.Adapters.SMTP},
287 type: {:dropdown, :atom},
288 description: "SMTP authentication mode",
289 suggestions: [:if_available, :always, :never]
292 group: {:subgroup, Swoosh.Adapters.SMTP},
295 description: "SMTP temporary (4xx) error retries",
299 group: {:subgroup, Swoosh.Adapters.Sendgrid},
303 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
304 suggestions: ["my-api-key"]
307 group: {:subgroup, Swoosh.Adapters.Sendmail},
310 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
311 suggestions: ["/usr/bin/sendmail"]
314 group: {:subgroup, Swoosh.Adapters.Sendmail},
317 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
318 suggestions: ["-N delay,failure,success"]
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
324 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
331 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
332 suggestions: ["my-api-key"]
335 group: {:subgroup, Swoosh.Adapters.Mailgun},
339 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
340 suggestions: ["my-api-key"]
343 group: {:subgroup, Swoosh.Adapters.Mailgun},
346 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
347 suggestions: ["pleroma.com"]
350 group: {:subgroup, Swoosh.Adapters.Mailjet},
354 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
355 suggestions: ["my-api-key"]
358 group: {:subgroup, Swoosh.Adapters.Mailjet},
361 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
362 suggestions: ["my-secret-key"]
365 group: {:subgroup, Swoosh.Adapters.Postmark},
369 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
370 suggestions: ["my-api-key"]
373 group: {:subgroup, Swoosh.Adapters.SparkPost},
377 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
378 suggestions: ["my-api-key"]
381 group: {:subgroup, Swoosh.Adapters.SparkPost},
384 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
385 suggestions: ["https://api.sparkpost.com/api/v1"]
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
391 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
392 suggestions: ["us-east-1", "us-east-2"]
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
398 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
399 suggestions: ["aws-access-key"]
402 group: {:subgroup, Swoosh.Adapters.AmazonSES},
405 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
406 suggestions: ["aws-secret-key"]
409 group: {:subgroup, Swoosh.Adapters.Dyn},
413 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
414 suggestions: ["my-api-key"]
417 group: {:subgroup, Swoosh.Adapters.SocketLabs},
420 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
423 group: {:subgroup, Swoosh.Adapters.SocketLabs},
427 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
430 group: {:subgroup, Swoosh.Adapters.Gmail},
433 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
440 label: "URI Schemes",
442 description: "URI schemes related settings",
446 type: {:list, :string},
447 description: "List of the scheme part that is considered valid to be an URL",
472 description: "Instance-related settings",
477 description: "Name of the instance",
484 label: "Admin Email Address",
486 description: "Email used to reach an Administrator/Moderator of the instance",
493 label: "Sender Email Address",
495 description: "Envelope FROM address for mail sent via Pleroma",
504 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
512 description: "Posts character limit (CW/Subject included in the counter)",
520 description: "Character limit of the instance chat messages",
528 description: "Hard character limit beyond which remote posts will be dropped",
536 description: "File size limit of uploads (except for avatar, background, banner)",
542 key: :avatar_upload_limit,
544 description: "File size limit of user's profile avatars",
550 key: :background_upload_limit,
552 description: "File size limit of user's profile backgrounds",
558 key: :banner_upload_limit,
560 description: "File size limit of user's profile banners",
568 description: "A map with poll limits for local polls",
572 max_option_chars: 200,
574 max_expiration: 31_536_000
581 description: "Maximum number of options",
585 key: :max_option_chars,
587 description: "Maximum number of characters per option",
591 key: :min_expiration,
593 description: "Minimum expiration time (in seconds)",
597 key: :max_expiration,
599 description: "Maximum expiration time (in seconds)",
605 key: :registrations_open,
608 "Enable registrations for anyone. Invitations require this setting to be disabled."
611 key: :invites_enabled,
614 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
617 key: :account_activation_required,
619 description: "Require users to confirm their emails before signing in"
622 key: :account_approval_required,
624 description: "Require users to be manually approved by an admin before signing in"
629 description: "Enable federation with other instances"
632 key: :federation_incoming_replies_max_depth,
633 label: "Fed. incoming replies max depth",
636 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
637 " 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.",
643 key: :federation_reachability_timeout_days,
644 label: "Fed. reachability timeout days",
647 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
655 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
661 "Makes the client API in authenticated mode-only except for user-profiles." <>
662 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
663 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
666 key: :quarantined_instances,
667 type: {:list, :string},
669 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
678 description: "Instance static directory",
684 key: :allowed_post_formats,
685 type: {:list, :string},
686 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
695 key: :extended_nickname_format,
698 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
699 " This will break federation with older software for theses nicknames."
702 key: :cleanup_attachments,
705 Enable to remove associated attachments when status is removed.
706 This will not affect duplicates and attachments without status.
707 Enabling this will increase load to database when deleting statuses on larger instances.
711 key: :max_pinned_statuses,
713 description: "The maximum number of pinned statuses. 0 will disable the feature.",
721 key: :autofollowed_nicknames,
722 type: {:list, :string},
724 "Set to nicknames of (local) users that every new user should automatically follow"
727 key: :autofollowing_nicknames,
728 type: {:list, :string},
730 "Set to nicknames of (local) users that automatically follows every newly registered user"
733 key: :attachment_links,
735 description: "Enable to automatically add attachment link text to statuses"
738 key: :max_report_comment_size,
740 description: "The maximum size of the report comment. Default: 1000.",
746 key: :safe_dm_mentions,
747 label: "Safe DM mentions",
750 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
751 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
757 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
760 key: :remote_post_retention_days,
763 "The default amount of days to retain remote posts when pruning the database",
769 key: :user_bio_length,
771 description: "A user bio maximum length. Default: 5000.",
777 key: :user_name_length,
779 description: "A user name maximum length. Default: 100.",
785 key: :skip_thread_containment,
787 description: "Skip filtering out broken threads. Default: enabled."
790 key: :limit_to_local_content,
791 type: {:dropdown, :atom},
793 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
801 key: :max_account_fields,
803 description: "The maximum number of custom fields in the user profile. Default: 10.",
809 key: :max_remote_account_fields,
812 "The maximum number of custom fields in the remote user profile. Default: 20.",
818 key: :account_field_name_length,
820 description: "An account field name maximum length. Default: 512.",
826 key: :account_field_value_length,
828 description: "An account field value maximum length. Default: 2048.",
834 key: :registration_reason_length,
836 description: "Maximum registration reason length. Default: 500.",
842 key: :external_user_synchronization,
844 description: "Enabling following/followers counters synchronization for external users"
847 key: :multi_factor_authentication,
849 description: "Multi-factor authentication settings",
852 totp: [digits: 6, period: 30],
853 backup_codes: [number: 5, length: 16]
859 label: "TOTP settings",
861 description: "TOTP settings",
862 suggestions: [digits: 6, period: 30],
869 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
876 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
883 description: "MFA backup codes settings",
884 suggestions: [number: 5, length: 16],
890 description: "Number of backup codes to generate."
897 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
904 key: :instance_thumbnail,
905 type: {:string, :image},
907 "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.",
908 suggestions: ["/instance/thumbnail.jpeg"]
911 key: :show_reactions,
913 description: "Let favourites and emoji reactions be viewed through the API."
921 description: "Welcome messages settings",
924 key: :direct_message,
926 descpiption: "Direct message settings",
931 description: "Enables sending a direct message to newly registered users"
936 description: "A message that will be sent to newly registered users",
938 "Hi, @username! Welcome on board!"
942 key: :sender_nickname,
944 description: "The nickname of the local user that sends a welcome message",
954 descpiption: "Chat message settings",
959 description: "Enables sending a chat message to newly registered users"
965 "A message that will be sent to newly registered users as a chat message",
967 "Hello, welcome on board!"
971 key: :sender_nickname,
973 description: "The nickname of the local user that sends a welcome chat message",
983 descpiption: "Email message settings",
988 description: "Enables sending an email to newly registered users"
992 type: [:string, :tuple],
994 "Email address and/or nickname that will be used to send the welcome email.",
996 {"Pleroma App", "welcome@pleroma.app"}
1003 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1004 suggestions: ["Welcome to <%= instance_name%>"]
1010 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1011 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1017 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1018 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1027 description: "Logger-related settings",
1031 type: [:atom, :tuple, :module],
1033 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1034 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1042 label: "ExSyslogger",
1043 description: "ExSyslogger-related settings",
1047 type: {:dropdown, :atom},
1048 description: "Log level",
1049 suggestions: [:debug, :info, :warn, :error]
1055 "A string that's prepended to every message, and is typically set to the app name",
1056 suggestions: ["pleroma"]
1061 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1062 suggestions: ["$metadata[$level] $message"]
1066 type: {:list, :atom},
1067 suggestions: [:request_id]
1075 label: "Console Logger",
1076 description: "Console logger settings",
1080 type: {:dropdown, :atom},
1081 description: "Log level",
1082 suggestions: [:debug, :info, :warn, :error]
1087 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1088 suggestions: ["$metadata[$level] $message"]
1092 type: {:list, :atom},
1093 suggestions: [:request_id]
1100 label: "Quack Logger",
1101 description: "Quack-related settings",
1105 type: {:dropdown, :atom},
1106 description: "Log level",
1107 suggestions: [:debug, :info, :warn, :error]
1111 type: {:list, :atom},
1112 description: "Configure which metadata you want to report on",
1129 label: "Webhook URL",
1131 description: "Configure the Slack incoming webhook",
1132 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1138 key: :frontend_configurations,
1141 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1142 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1143 "add your own configuration your settings all fields must be complete.",
1147 label: "Pleroma FE",
1149 description: "Settings for Pleroma FE",
1152 alwaysShowSubjectInput: true,
1153 background: "/static/aurora_borealis.jpg",
1154 collapseMessageWithSubject: false,
1157 hideFilteredStatuses: false,
1158 hideMutedPosts: false,
1159 hidePostStats: false,
1160 hideSitename: false,
1161 hideUserStats: false,
1162 loginMethod: "password",
1163 logo: "/static/logo.svg",
1166 minimalScopesMode: false,
1167 noAttachmentLinks: false,
1168 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1169 postContentType: "text/plain",
1170 redirectRootLogin: "/main/friends",
1171 redirectRootNoLogin: "/main/all",
1173 sidebarRight: false,
1174 showFeaturesPanel: true,
1175 showInstanceSpecificPanel: false,
1176 subjectLineBehavior: "email",
1177 theme: "pleroma-dark",
1178 webPushNotifications: false
1183 key: :alwaysShowSubjectInput,
1184 label: "Always show subject input",
1186 description: "When disabled, auto-hide the subject field if it's empty"
1190 type: {:string, :image},
1192 "URL of the background, unless viewing a user profile with a background that is set",
1193 suggestions: ["/images/city.jpg"]
1196 key: :collapseMessageWithSubject,
1197 label: "Collapse message with subject",
1200 "When a message has a subject (aka Content Warning), collapse it by default"
1204 label: "PleromaFE Chat",
1206 description: "Disables PleromaFE Chat component"
1212 description: "Enables green text on lines prefixed with the > character"
1215 key: :hideFilteredStatuses,
1216 label: "Hide Filtered Statuses",
1218 description: "Hides filtered statuses from timelines"
1221 key: :hideMutedPosts,
1222 label: "Hide Muted Posts",
1224 description: "Hides muted statuses from timelines"
1227 key: :hidePostStats,
1228 label: "Hide post stats",
1230 description: "Hide notices statistics (repeats, favorites, ...)"
1234 label: "Hide Sitename",
1236 description: "Hides instance name from PleromaFE banner"
1239 key: :hideUserStats,
1240 label: "Hide user stats",
1243 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1247 type: {:string, :image},
1248 description: "URL of the logo, defaults to Pleroma's logo",
1249 suggestions: ["/static/logo.svg"]
1253 label: "Logo margin",
1256 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1257 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1258 suggestions: [".1em"]
1265 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1266 "If you want a colorful logo you must disable logoMask."
1269 key: :minimalScopesMode,
1270 label: "Minimal scopes mode",
1273 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1274 "Also prevents replying to a DM with a public post from PleromaFE."
1277 key: :nsfwCensorImage,
1278 label: "NSFW Censor Image",
1279 type: {:string, :image},
1281 "URL of the image to use for hiding NSFW media attachments in the timeline",
1282 suggestions: ["/static/img/nsfw.74818f9.png"]
1285 key: :postContentType,
1286 label: "Post Content Type",
1287 type: {:dropdown, :atom},
1288 description: "Default post formatting option",
1289 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1292 key: :redirectRootNoLogin,
1293 label: "Redirect root no login",
1296 "Relative URL which indicates where to redirect when a user isn't logged in",
1297 suggestions: ["/main/all"]
1300 key: :redirectRootLogin,
1301 label: "Redirect root login",
1304 "Relative URL which indicates where to redirect when a user is logged in",
1305 suggestions: ["/main/friends"]
1309 label: "Scope copy",
1311 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1315 label: "Sidebar on Right",
1317 description: "Change alignment of sidebar and panels to the right"
1320 key: :showFeaturesPanel,
1321 label: "Show instance features panel",
1324 "Enables panel displaying functionality of the instance on the About page"
1327 key: :showInstanceSpecificPanel,
1328 label: "Show instance specific panel",
1330 description: "Whether to show the instance's custom panel"
1333 key: :subjectLineBehavior,
1334 label: "Subject line behavior",
1336 description: "Allows changing the default behaviour of subject lines in replies.
1337 `email`: copy and preprend re:, as in email,
1338 `masto`: copy verbatim, as in Mastodon,
1339 `noop`: don't copy the subject.",
1340 suggestions: ["email", "masto", "noop"]
1345 description: "Which theme to use. Available themes are defined in styles.json",
1346 suggestions: ["pleroma-dark"]
1354 description: "Settings for Masto FE",
1357 showInstanceSpecificPanel: true
1362 key: :showInstanceSpecificPanel,
1363 label: "Show instance specific panel",
1365 description: "Whenether to show the instance's specific panel"
1376 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1380 type: {:keyword, :map},
1382 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1385 url: "/images/pleroma-fox-tan-smol.png",
1386 mime_type: "image/png"
1388 pleroma_fox_tan_shy: %{
1389 url: "/images/pleroma-fox-tan-shy.png",
1390 mime_type: "image/png"
1395 key: :default_mascot,
1398 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1404 key: :default_user_avatar,
1405 type: {:string, :image},
1406 description: "URL of the default user avatar",
1407 suggestions: ["/images/avi.png"]
1416 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1420 type: {:list, :map},
1421 description: "Describe the icons of the app",
1424 src: "/static/logo.png"
1427 src: "/static/icon.png",
1431 src: "/static/icon.ico",
1432 sizes: "72x72 96x96 128x128 256x256"
1439 description: "Describe the theme color of the app",
1440 suggestions: ["#282c37", "mediumpurple"]
1443 key: :background_color,
1445 description: "Describe the background color of the app",
1446 suggestions: ["#191b22", "aliceblue"]
1454 description: "Media proxy",
1459 description: "Enables proxying of remote media via the instance's proxy"
1466 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1467 suggestions: ["https://example.com"]
1475 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1481 description: "Enables media cache object invalidation."
1486 description: "Module which will be used to purge objects from the cache.",
1488 Pleroma.Web.MediaProxy.Invalidation.Script,
1489 Pleroma.Web.MediaProxy.Invalidation.Http
1496 label: "Advanced MediaProxy Options",
1498 description: "Internal Pleroma.ReverseProxy settings",
1500 redirect_on_failure: false,
1501 max_body_length: 25 * 1_048_576,
1502 max_read_duration: 30_000
1506 key: :redirect_on_failure,
1509 Redirects the client to the origin server upon encountering HTTP errors.\n
1510 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1511 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1512 IP addresses of your users to the other servers, bypassing the MediaProxy.
1516 key: :max_body_length,
1518 description: "Maximum file size allowed through the Pleroma MediaProxy cache."
1521 key: :max_read_duration,
1523 description: "Timeout (in milliseconds) of GET request to the remote URI."
1529 type: {:list, :string},
1530 description: "List of hosts with scheme to bypass the MediaProxy",
1531 suggestions: ["http://example.com"]
1537 key: :media_preview_proxy,
1539 description: "Media preview proxy",
1545 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1548 key: :thumbnail_max_width,
1551 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1554 key: :thumbnail_max_height,
1557 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1560 key: :image_quality,
1562 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1565 key: :min_content_length,
1568 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1574 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1576 description: "HTTP invalidate settings",
1581 description: "HTTP method of request. Default: :purge"
1585 type: {:keyword, :string},
1586 description: "HTTP headers of request",
1587 suggestions: [{"x-refresh", 1}]
1592 description: "Request options",
1596 type: {:map, :string}
1604 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1606 description: "Invalidation script settings",
1611 description: "Path to executable script which will purge cached items.",
1612 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1618 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1619 suggestions: [":htcacheclean"]
1627 description: "Gopher settings",
1632 description: "Enables the gopher interface"
1638 description: "IP address to bind to",
1639 suggestions: [{0, 0, 0, 0}]
1644 description: "Port to bind to",
1650 description: "Port advertised in URLs (optional, defaults to port)",
1658 label: "ActivityPub",
1660 description: "ActivityPub-related settings",
1663 key: :unfollow_blocked,
1665 description: "Whether blocks result in people getting unfollowed"
1668 key: :outgoing_blocks,
1670 description: "Whether to federate blocks to other instances"
1673 key: :sign_object_fetches,
1675 description: "Sign object fetches with HTTP signatures"
1678 key: :note_replies_output_limit,
1681 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1684 key: :follow_handshake_timeout,
1686 description: "Following handshake timeout",
1693 key: :http_security,
1694 label: "HTTP security",
1696 description: "HTTP security settings",
1701 description: "Whether the managed content security policy is enabled"
1707 description: "Whether to additionally send a Strict-Transport-Security header"
1711 label: "STS max age",
1713 description: "The maximum age for the Strict-Transport-Security header if sent",
1714 suggestions: [31_536_000]
1718 label: "CT max age",
1720 description: "The maximum age for the Expect-CT header if sent",
1721 suggestions: [2_592_000]
1724 key: :referrer_policy,
1726 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1727 suggestions: ["same-origin", "no-referrer"]
1731 label: "Report URI",
1733 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1734 suggestions: ["https://example.com/report-uri"]
1739 group: :web_push_encryption,
1740 key: :vapid_details,
1741 label: "Vapid Details",
1744 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1750 "A mailto link for the administrative contact." <>
1751 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1752 suggestions: ["mailto:moderators@pleroma.com"]
1757 description: "VAPID public key",
1758 suggestions: ["Public key"]
1763 description: "VAPID private key",
1764 suggestions: ["Private key"]
1770 key: Pleroma.Captcha,
1772 description: "Captcha-related settings",
1777 description: "Whether the captcha should be shown on registration"
1782 description: "The method/service to use for captcha",
1783 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1786 key: :seconds_valid,
1788 description: "The time in seconds for which the captcha is valid",
1795 key: Pleroma.Captcha.Kocaptcha,
1798 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1799 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1804 description: "The kocaptcha endpoint to use",
1805 suggestions: ["https://captcha.kotobank.ch"]
1811 label: "Pleroma Admin Token",
1814 "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)",
1819 description: "Admin token",
1821 "Please use a high entropy string or UUID"
1831 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1835 type: {:dropdown, :atom},
1836 description: "Logs verbose mode",
1837 suggestions: [false, :error, :warn, :info, :debug]
1841 type: {:keyword, :integer},
1843 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1845 activity_expiration: 10,
1846 attachments_cleanup: 5,
1848 federator_incoming: 50,
1849 federator_outgoing: 50,
1851 scheduled_activities: 10,
1857 key: :activity_expiration,
1859 description: "Activity expiration queue",
1865 description: "Backup queue",
1869 key: :attachments_cleanup,
1871 description: "Attachment deletion queue",
1877 description: "Background queue",
1881 key: :federator_incoming,
1883 description: "Incoming federation queue",
1887 key: :federator_outgoing,
1889 description: "Outgoing federation queue",
1895 description: "Email sender queue, see Pleroma.Emails.Mailer",
1899 key: :scheduled_activities,
1901 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1905 key: :transmogrifier,
1907 description: "Transmogrifier queue",
1913 description: "Web push notifications queue",
1920 type: {:list, :tuple},
1921 description: "Settings for cron background jobs",
1923 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1924 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1933 description: "Includes custom worker options not interpretable directly by `Oban`",
1937 type: {:keyword, :integer},
1938 description: "Max retry attempts for failed jobs, per `Oban` queue",
1940 federator_incoming: 5,
1941 federator_outgoing: 5
1948 key: Pleroma.Web.Metadata,
1950 description: "Metadata-related settings",
1954 type: {:list, :module},
1955 description: "List of metadata providers to enable",
1957 Pleroma.Web.Metadata.Providers.OpenGraph,
1958 Pleroma.Web.Metadata.Providers.TwitterCard,
1959 Pleroma.Web.Metadata.Providers.RelMe,
1960 Pleroma.Web.Metadata.Providers.Feed
1965 label: "Unfurl NSFW",
1967 description: "When enabled NSFW attachments will be shown in previews"
1976 "If enabled the instance will parse metadata from attached links to generate link previews",
1981 description: "Enables RichMedia parsing of URLs"
1985 type: {:list, :string},
1986 description: "List of hosts which will be ignored by the metadata parser",
1987 suggestions: ["accounts.google.com", "xss.website"]
1991 label: "Ignore TLD",
1992 type: {:list, :string},
1993 description: "List TLDs (top-level domains) which will ignore for parse metadata",
1994 suggestions: ["local", "localdomain", "lan"]
1998 type: {:list, :module},
2000 "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.",
2002 Pleroma.Web.RichMedia.Parsers.OEmbed,
2003 Pleroma.Web.RichMedia.Parsers.TwitterCard
2008 label: "TTL setters",
2009 type: {:list, :module},
2011 "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.",
2013 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2017 key: :failure_backoff,
2020 "Amount of milliseconds after request failure, during which the request will not be retried.",
2021 suggestions: [60_000]
2027 key: Pleroma.Formatter,
2031 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2035 type: [:string, :boolean],
2036 description: "Specify the class to be added to the generated link. Disable to clear.",
2037 suggestions: ["auto-linker", false]
2041 type: [:string, :boolean],
2042 description: "Override the rel attribute. Disable to clear.",
2043 suggestions: ["ugc", "noopener noreferrer", false]
2048 description: "Link URLs will open in a new window/tab."
2052 type: [:integer, :boolean],
2054 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2055 suggestions: [15, false]
2060 description: "Strip the scheme prefix."
2065 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2069 type: [:atom, :boolean],
2071 "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)",
2072 suggestions: [:no_scheme, true]
2078 key: Pleroma.ScheduledActivity,
2080 description: "Scheduled activities settings",
2083 key: :daily_user_limit,
2086 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2090 key: :total_user_limit,
2093 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2099 description: "Whether scheduled activities are sent to the job queue to be executed"
2105 key: Pleroma.Workers.PurgeExpiredActivity,
2107 description: "Expired activities settings",
2112 description: "Enables expired activities addition & deletion"
2117 description: "Minimum lifetime for ephemeral activity (in seconds)",
2124 label: "Pleroma Authenticator",
2126 description: "Authenticator",
2129 key: Pleroma.Web.Auth.Authenticator,
2131 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2141 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2142 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2143 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2144 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2149 description: "Enables LDAP authentication"
2154 description: "LDAP server hostname",
2155 suggestions: ["localhosts"]
2160 description: "LDAP port, e.g. 389 or 636",
2161 suggestions: [389, 636]
2167 description: "Enable to use SSL, usually implies the port 636"
2171 label: "SSL options",
2173 description: "Additional SSL options",
2174 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2179 description: "Path to file with PEM encoded cacerts",
2180 suggestions: ["path/to/file/with/PEM/cacerts"]
2185 description: "Type of cert verification",
2186 suggestions: [:verify_peer]
2194 description: "Enable to use STARTTLS, usually implies the port 389"
2198 label: "TLS options",
2200 description: "Additional TLS options",
2201 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2206 description: "Path to file with PEM encoded cacerts",
2207 suggestions: ["path/to/file/with/PEM/cacerts"]
2212 description: "Type of cert verification",
2213 suggestions: [:verify_peer]
2220 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2221 suggestions: ["dc=example,dc=com"]
2228 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2237 description: "Authentication / authorization settings",
2240 key: :enforce_oauth_admin_scope_usage,
2241 label: "Enforce OAuth admin scope usage",
2244 "OAuth admin scope requirement toggle. " <>
2245 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2246 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2247 "`is_admin` user flag grants access to admin-specific actions."
2250 key: :auth_template,
2253 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2254 suggestions: ["show.html"]
2257 key: :oauth_consumer_template,
2258 label: "OAuth consumer template",
2261 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2262 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2263 suggestions: ["consumer.html"]
2266 key: :oauth_consumer_strategies,
2267 label: "OAuth consumer strategies",
2268 type: {:list, :string},
2270 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2271 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2272 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2273 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2279 key: :email_notifications,
2281 description: "Email notifications settings",
2287 "emails of \"what you've missed\" for users who have been inactive for a while",
2291 schedule: "0 0 * * 0",
2293 inactivity_threshold: 7
2301 description: "Globally enable or disable digest emails"
2307 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2308 suggestions: ["0 0 * * 0"]
2313 description: "Minimum interval between digest emails to one user",
2317 key: :inactivity_threshold,
2319 description: "Minimum user inactivity threshold",
2328 key: Pleroma.Emails.UserEmail,
2330 description: "Email template settings",
2334 type: {:string, :image},
2335 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2336 suggestions: ["some/path/logo.png"]
2341 description: "A map with color settings for email templates.",
2344 link_color: "#d8a070",
2345 background_color: "#2C3645",
2346 content_background_color: "#1B2635",
2347 header_color: "#d8a070",
2348 text_color: "#b9b9ba",
2349 text_muted_color: "#b9b9ba"
2356 suggestions: ["#d8a070"]
2359 key: :background_color,
2361 suggestions: ["#2C3645"]
2364 key: :content_background_color,
2366 suggestions: ["#1B2635"]
2371 suggestions: ["#d8a070"]
2376 suggestions: ["#b9b9ba"]
2379 key: :text_muted_color,
2381 suggestions: ["#b9b9ba"]
2389 key: Pleroma.Emails.NewUsersDigestEmail,
2391 description: "New users admin email digest",
2396 description: "Enables new users admin digest email when `true`"
2405 description: "Configure OAuth 2 provider capabilities",
2408 key: :token_expires_in,
2410 description: "The lifetime in seconds of the access token",
2411 suggestions: [2_592_000]
2414 key: :issue_new_refresh_token,
2417 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2420 key: :clean_expired_tokens,
2422 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2432 key: :shortcode_globs,
2433 type: {:list, :string},
2434 description: "Location of custom emoji files. * can be used as a wildcard.",
2435 suggestions: ["/emoji/custom/**/*.png"]
2438 key: :pack_extensions,
2439 type: {:list, :string},
2441 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2442 suggestions: [".png", ".gif"]
2446 type: {:keyword, {:list, :string}},
2448 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2449 " and the value is the location or array of locations. * can be used as a wildcard.",
2451 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2455 key: :default_manifest,
2458 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2459 " Currently only one manifest can be added (no arrays).",
2460 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2463 key: :shared_pack_cache_seconds_per_file,
2464 label: "Shared pack cache s/file",
2467 "When an emoji pack is shared, the archive is created and cached in memory" <>
2468 " for this amount of seconds multiplied by the number of files.",
2478 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2482 type: [:tuple, {:list, :tuple}],
2483 description: "For the search requests (account & status search etc.)",
2484 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2488 type: [:tuple, {:list, :tuple}],
2489 description: "For requests to timelines (each timeline has it's own limiter)",
2490 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2493 key: :app_account_creation,
2494 type: [:tuple, {:list, :tuple}],
2495 description: "For registering user accounts from the same IP address",
2496 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2499 key: :relations_actions,
2500 type: [:tuple, {:list, :tuple}],
2501 description: "For actions on relationships with all users (follow, unfollow)",
2502 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2505 key: :relation_id_action,
2506 label: "Relation ID action",
2507 type: [:tuple, {:list, :tuple}],
2508 description: "For actions on relation with a specific user (follow, unfollow)",
2509 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2512 key: :statuses_actions,
2513 type: [:tuple, {:list, :tuple}],
2515 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2516 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2519 key: :status_id_action,
2520 label: "Status ID action",
2521 type: [:tuple, {:list, :tuple}],
2523 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2524 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2527 key: :authentication,
2528 type: [:tuple, {:list, :tuple}],
2529 description: "For authentication create / password check / user existence check requests",
2530 suggestions: [{60_000, 15}]
2539 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2540 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2545 description: "Enables SSH"
2550 description: "Dir with SSH keys",
2551 suggestions: ["/some/path/ssh_keys"]
2556 description: "Handler module",
2557 suggestions: ["Pleroma.BBS.Handler"]
2562 description: "Port to connect",
2563 suggestions: [10_022]
2566 key: :password_authenticator,
2568 description: "Authenticator module",
2569 suggestions: ["Pleroma.BBS.Authenticator"]
2575 label: "Mime Types",
2577 description: "Mime Types settings",
2584 "application/xml" => ["xml"],
2585 "application/xrd+xml" => ["xrd+xml"],
2586 "application/jrd+json" => ["jrd+json"],
2587 "application/activity+json" => ["activity+json"],
2588 "application/ld+json" => ["activity+json"]
2593 key: "application/xml",
2594 type: {:list, :string},
2595 suggestions: ["xml"]
2598 key: "application/xrd+xml",
2599 type: {:list, :string},
2600 suggestions: ["xrd+xml"]
2603 key: "application/jrd+json",
2604 type: {:list, :string},
2605 suggestions: ["jrd+json"]
2608 key: "application/activity+json",
2609 type: {:list, :string},
2610 suggestions: ["activity+json"]
2613 key: "application/ld+json",
2614 type: {:list, :string},
2615 suggestions: ["activity+json"]
2625 description: "Pleroma chat settings",
2638 description: "HTTP settings",
2643 type: [:string, :tuple],
2644 description: "Proxy URL",
2645 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2648 key: :send_user_agent,
2653 type: [:string, :atom],
2655 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2656 suggestions: ["Pleroma", :default]
2661 description: "Adapter specific options",
2667 label: "SSL Options",
2668 description: "SSL options for HTTP adapter",
2672 type: {:list, :atom},
2673 description: "List of TLS version to use",
2674 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2685 label: "Markup Settings",
2689 key: :allow_inline_images,
2693 key: :allow_headings,
2706 type: {:list, :module},
2708 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2709 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2719 key: :deny_follow_blocked,
2730 key: :restricted_nicknames,
2731 type: {:list, :string},
2732 description: "List of nicknames users may not register with.",
2751 "ostatus_subscribe",
2767 key: :email_blacklist,
2768 type: {:list, :string},
2769 description: "List of email domains users may not register with.",
2770 suggestions: ["mailinator.com", "maildrop.cc"]
2776 label: "CORS plug config",
2782 suggestions: [86_400]
2786 type: {:list, :string},
2787 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2791 type: {:list, :string},
2794 "X-RateLimit-Reset",
2795 "X-RateLimit-Limit",
2796 "X-RateLimit-Remaining",
2807 type: {:list, :string},
2808 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2814 key: Pleroma.Web.Plugs.RemoteIp,
2817 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2818 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2824 description: "Enable/disable the plug. Default: disabled."
2828 type: {:list, :string},
2830 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2835 type: {:list, :string},
2837 "A list of upstream proxy IP subnets in CIDR notation from which we will parse the content of `headers`. Defaults to `[]`. IPv4 entries without a bitmask will be assumed to be /32 and IPv6 /128."
2841 type: {:list, :string},
2843 A list of reserved IP subnets in CIDR notation which should be ignored if found in `headers`. Defaults to `["127.0.0.0/8", "::1/128", "fc00::/7", "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"]`
2850 key: :web_cache_ttl,
2851 label: "Web cache TTL",
2854 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2860 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2861 suggestions: [30_000, nil]
2864 key: :activity_pub_question,
2866 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2867 suggestions: [30_000]
2877 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2882 description: "Enables the rendering of static HTML. Default: disabled."
2890 description: "Configure feed rendering",
2895 description: "Configure title rendering",
2900 description: "Maximum number of characters before truncating title",
2906 description: "Replacement which will be used after truncating string",
2907 suggestions: ["..."]
2917 description: "Custom Runtime Modules",
2922 description: "A path to custom Elixir modules (such as MRF policies)."
2930 description: "Settings for notifications streamer",
2935 description: "Number of workers to send notifications",
2939 key: :overflow_workers,
2941 description: "Maximum number of workers created if pool is empty",
2948 key: :connections_pool,
2950 description: "Advanced settings for `Gun` connections pool",
2953 key: :connection_acquisition_wait,
2956 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2960 key: :connection_acquisition_retries,
2963 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2967 key: :max_connections,
2969 description: "Maximum number of connections in the pool. Default: 250 connections.",
2973 key: :connect_timeout,
2975 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
2979 key: :reclaim_multiplier,
2982 "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",
2991 description: "Advanced settings for `Gun` workers pools",
2993 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
2997 description: "Settings for #{pool_name} pool.",
3002 description: "Maximum number of concurrent requests in the pool.",
3009 "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",
3015 description: "Timeout for the pool while gun will wait for response",
3016 suggestions: [10_000]
3024 key: :hackney_pools,
3026 description: "Advanced settings for `Hackney` connections pools",
3031 description: "Settings for federation pool.",
3034 key: :max_connections,
3036 description: "Number workers in the pool.",
3042 description: "Timeout while `hackney` will wait for response.",
3043 suggestions: [150_000]
3050 description: "Settings for media pool.",
3053 key: :max_connections,
3055 description: "Number workers in the pool.",
3061 description: "Timeout while `hackney` will wait for response.",
3062 suggestions: [150_000]
3069 description: "Settings for upload pool.",
3072 key: :max_connections,
3074 description: "Number workers in the pool.",
3080 description: "Timeout while `hackney` will wait for response.",
3081 suggestions: [300_000]
3089 key: :restrict_unauthenticated,
3090 label: "Restrict Unauthenticated",
3093 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3098 description: "Settings for public and federated timelines.",
3103 description: "Disallow view public timeline."
3108 description: "Disallow view federated timeline."
3115 description: "Settings for user profiles.",
3120 description: "Disallow view local user profiles."
3125 description: "Disallow view remote user profiles."
3132 description: "Settings for statuses.",
3137 description: "Disallow view local statuses."
3142 description: "Disallow view remote statuses."
3150 key: Pleroma.Web.ApiSpec.CastAndValidate,
3157 "Enables strict input validation (useful in development, not recommended in production)"
3163 key: :instances_favicons,
3165 description: "Control favicons for instances",
3170 description: "Allow/disallow displaying and getting instances favicons"
3178 descriptions: "S3 service related settings",
3181 key: :access_key_id,
3183 description: "S3 access key ID",
3184 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3187 key: :secret_access_key,
3189 description: "Secret access key",
3190 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3195 description: "S3 host",
3196 suggestions: ["s3.eu-central-1.amazonaws.com"]
3201 description: "S3 region (for AWS)",
3202 suggestions: ["us-east-1"]
3210 description: "Installed frontends management",
3215 description: "Primary frontend, the one that is served for all pages by default",
3216 children: installed_frontend_options
3221 description: "Admin frontend",
3222 children: installed_frontend_options
3228 "A map containing available frontends and parameters for their installation.",
3229 children: frontend_options
3235 key: Pleroma.Web.Preload,
3237 description: "Preload-related settings",
3241 type: {:list, :module},
3242 description: "List of preload providers to enable",
3244 Pleroma.Web.Preload.Providers.Instance,
3245 Pleroma.Web.Preload.Providers.User,
3246 Pleroma.Web.Preload.Providers.Timelines,
3247 Pleroma.Web.Preload.Providers.StatusNet
3256 description: "Majic/libmagic configuration",
3261 description: "Number of majic workers to start.",
3268 key: Pleroma.User.Backup,
3270 description: "Account Backup",
3273 key: :purge_after_days,
3275 description: "Remove backup achives after N days",
3281 description: "Limit user to export not more often than once per N days",
3288 key: Pleroma.Web.Endpoint.MetricsExporter,
3290 description: "Prometheus app metrics endpoint configuration",
3295 description: "[Pleroma extension] Enables app metrics endpoint."
3299 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3301 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3305 type: [:boolean, :tuple],
3306 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3307 suggestion: [false, {:basic, "myusername", "mypassword"}]
3312 description: "App metrics endpoint URI path.",
3313 suggestions: ["/api/pleroma/app_metrics"]
3318 description: "App metrics endpoint output format.",
3319 suggestions: [:text, :protobuf]
3325 key: ConcurrentLimiter,
3327 description: "Limits configuration for background tasks.",
3330 key: Pleroma.Web.RichMedia.Helpers,
3332 description: "Concurrent limits configuration for getting RichMedia for activities.",
3333 suggestions: [max_running: 5, max_waiting: 5],
3338 description: "Max running concurrently jobs.",
3344 description: "Max waiting jobs.",
3350 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3352 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3353 suggestions: [max_running: 5, max_waiting: 5],
3358 description: "Max running concurrently jobs.",
3364 description: "Max waiting jobs.",