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: "Pleroma Email sending capability"
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},
279 label: "STARTTLS Mode",
280 type: {:dropdown, :atom},
281 description: "Explicit TLS (STARTTLS) enforcement mode",
282 suggestions: [:if_available, :always, :never]
285 group: {:subgroup, Swoosh.Adapters.SMTP},
288 type: {:dropdown, :atom},
289 description: "SMTP AUTH enforcement mode",
290 suggestions: [:if_available, :always, :never]
293 group: {:subgroup, Swoosh.Adapters.SMTP},
296 description: "SMTP temporary (4xx) error retries",
300 group: {:subgroup, Swoosh.Adapters.Sendgrid},
304 description: "`Swoosh.Adapters.Sendgrid` adapter specific setting",
305 suggestions: ["my-api-key"]
308 group: {:subgroup, Swoosh.Adapters.Sendmail},
311 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
312 suggestions: ["/usr/bin/sendmail"]
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
318 description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
319 suggestions: ["-N delay,failure,success"]
322 group: {:subgroup, Swoosh.Adapters.Sendmail},
325 description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
328 group: {:subgroup, Swoosh.Adapters.Mandrill},
332 description: "`Swoosh.Adapters.Mandrill` adapter specific setting",
333 suggestions: ["my-api-key"]
336 group: {:subgroup, Swoosh.Adapters.Mailgun},
340 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
341 suggestions: ["my-api-key"]
344 group: {:subgroup, Swoosh.Adapters.Mailgun},
347 description: "`Swoosh.Adapters.Mailgun` adapter specific setting",
348 suggestions: ["pleroma.com"]
351 group: {:subgroup, Swoosh.Adapters.Mailjet},
355 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
356 suggestions: ["my-api-key"]
359 group: {:subgroup, Swoosh.Adapters.Mailjet},
362 description: "`Swoosh.Adapters.Mailjet` adapter specific setting",
363 suggestions: ["my-secret-key"]
366 group: {:subgroup, Swoosh.Adapters.Postmark},
370 description: "`Swoosh.Adapters.Postmark` adapter specific setting",
371 suggestions: ["my-api-key"]
374 group: {:subgroup, Swoosh.Adapters.SparkPost},
378 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
379 suggestions: ["my-api-key"]
382 group: {:subgroup, Swoosh.Adapters.SparkPost},
385 description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
386 suggestions: ["https://api.sparkpost.com/api/v1"]
389 group: {:subgroup, Swoosh.Adapters.AmazonSES},
392 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
393 suggestions: ["us-east-1", "us-east-2"]
396 group: {:subgroup, Swoosh.Adapters.AmazonSES},
399 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
400 suggestions: ["aws-access-key"]
403 group: {:subgroup, Swoosh.Adapters.AmazonSES},
406 description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
407 suggestions: ["aws-secret-key"]
410 group: {:subgroup, Swoosh.Adapters.Dyn},
414 description: "`Swoosh.Adapters.Dyn` adapter specific setting",
415 suggestions: ["my-api-key"]
418 group: {:subgroup, Swoosh.Adapters.SocketLabs},
421 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
424 group: {:subgroup, Swoosh.Adapters.SocketLabs},
428 description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
431 group: {:subgroup, Swoosh.Adapters.Gmail},
434 description: "`Swoosh.Adapters.Gmail` adapter specific setting"
441 label: "URI Schemes",
443 description: "URI schemes related settings",
447 type: {:list, :string},
448 description: "List of the scheme part that is considered valid to be an URL",
473 description: "Instance-related settings",
478 description: "Name of the instance",
485 label: "Admin Email Address",
487 description: "Email used to reach an Administrator/Moderator of the instance",
494 label: "Sender Email Address",
496 description: "Envelope FROM address for mail sent via Pleroma",
505 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
513 description: "Posts character limit (CW/Subject included in the counter)",
521 description: "Character limit of the instance chat messages",
529 description: "Hard character limit beyond which remote posts will be dropped",
537 description: "File size limit of uploads (except for avatar, background, banner)",
543 key: :avatar_upload_limit,
545 description: "File size limit of user's profile avatars",
551 key: :background_upload_limit,
553 description: "File size limit of user's profile backgrounds",
559 key: :banner_upload_limit,
561 description: "File size limit of user's profile banners",
569 description: "A map with poll limits for local polls",
573 max_option_chars: 200,
575 max_expiration: 31_536_000
582 description: "Maximum number of options",
586 key: :max_option_chars,
588 description: "Maximum number of characters per option",
592 key: :min_expiration,
594 description: "Minimum expiration time (in seconds)",
598 key: :max_expiration,
600 description: "Maximum expiration time (in seconds)",
606 key: :registrations_open,
609 "Enable registrations for anyone. Invitations require this setting to be disabled."
612 key: :invites_enabled,
615 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
618 key: :account_activation_required,
620 description: "Require users to confirm their emails before signing in"
623 key: :account_approval_required,
625 description: "Require users to be manually approved by an admin before signing in"
630 description: "Enable federation with other instances"
633 key: :federation_incoming_replies_max_depth,
634 label: "Fed. incoming replies max depth",
637 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
638 " 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.",
644 key: :federation_reachability_timeout_days,
645 label: "Fed. reachability timeout days",
648 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
656 description: "Enable Pleroma's Relay, which makes it possible to follow a whole instance"
662 "Makes the client API in authenticated mode-only except for user-profiles." <>
663 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
664 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
667 key: :quarantined_instances,
668 type: {:list, :string},
670 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent",
679 description: "Instance static directory",
685 key: :allowed_post_formats,
686 type: {:list, :string},
687 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
696 key: :extended_nickname_format,
699 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
700 " This will break federation with older software for theses nicknames."
703 key: :cleanup_attachments,
706 Enable to remove associated attachments when status is removed.
707 This will not affect duplicates and attachments without status.
708 Enabling this will increase load to database when deleting statuses on larger instances.
712 key: :max_pinned_statuses,
714 description: "The maximum number of pinned statuses. 0 will disable the feature.",
722 key: :autofollowed_nicknames,
723 type: {:list, :string},
725 "Set to nicknames of (local) users that every new user should automatically follow"
728 key: :autofollowing_nicknames,
729 type: {:list, :string},
731 "Set to nicknames of (local) users that automatically follows every newly registered user"
734 key: :attachment_links,
736 description: "Enable to automatically add attachment link text to statuses"
739 key: :max_report_comment_size,
741 description: "The maximum size of the report comment. Default: 1000.",
747 key: :safe_dm_mentions,
748 label: "Safe DM mentions",
751 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
752 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
758 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
761 key: :remote_post_retention_days,
764 "The default amount of days to retain remote posts when pruning the database",
770 key: :user_bio_length,
772 description: "A user bio maximum length. Default: 5000.",
778 key: :user_name_length,
780 description: "A user name maximum length. Default: 100.",
786 key: :skip_thread_containment,
788 description: "Skip filtering out broken threads. Default: enabled."
791 key: :limit_to_local_content,
792 type: {:dropdown, :atom},
794 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
802 key: :max_account_fields,
804 description: "The maximum number of custom fields in the user profile. Default: 10.",
810 key: :max_remote_account_fields,
813 "The maximum number of custom fields in the remote user profile. Default: 20.",
819 key: :account_field_name_length,
821 description: "An account field name maximum length. Default: 512.",
827 key: :account_field_value_length,
829 description: "An account field value maximum length. Default: 2048.",
835 key: :registration_reason_length,
837 description: "Maximum registration reason length. Default: 500.",
843 key: :external_user_synchronization,
845 description: "Enabling following/followers counters synchronization for external users"
848 key: :multi_factor_authentication,
850 description: "Multi-factor authentication settings",
853 totp: [digits: 6, period: 30],
854 backup_codes: [number: 5, length: 16]
860 label: "TOTP settings",
862 description: "TOTP settings",
863 suggestions: [digits: 6, period: 30],
870 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
877 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
884 description: "MFA backup codes settings",
885 suggestions: [number: 5, length: 16],
891 description: "Number of backup codes to generate."
898 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
905 key: :instance_thumbnail,
906 type: {:string, :image},
908 "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.",
909 suggestions: ["/instance/thumbnail.jpeg"]
912 key: :show_reactions,
914 description: "Let favourites and emoji reactions be viewed through the API."
922 description: "Welcome messages settings",
925 key: :direct_message,
927 descpiption: "Direct message settings",
932 description: "Enables sending a direct message to newly registered users"
937 description: "A message that will be sent to newly registered users",
939 "Hi, @username! Welcome on board!"
943 key: :sender_nickname,
945 description: "The nickname of the local user that sends a welcome message",
955 descpiption: "Chat message settings",
960 description: "Enables sending a chat message to newly registered users"
966 "A message that will be sent to newly registered users as a chat message",
968 "Hello, welcome on board!"
972 key: :sender_nickname,
974 description: "The nickname of the local user that sends a welcome chat message",
984 descpiption: "Email message settings",
989 description: "Enables sending an email to newly registered users"
993 type: [:string, :tuple],
995 "Email address and/or nickname that will be used to send the welcome email.",
997 {"Pleroma App", "welcome@pleroma.app"}
1004 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1005 suggestions: ["Welcome to <%= instance_name%>"]
1011 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1012 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1018 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1019 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1028 description: "Logger-related settings",
1032 type: [:atom, :tuple, :module],
1034 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1035 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1043 label: "ExSyslogger",
1044 description: "ExSyslogger-related settings",
1048 type: {:dropdown, :atom},
1049 description: "Log level",
1050 suggestions: [:debug, :info, :warn, :error]
1056 "A string that's prepended to every message, and is typically set to the app name",
1057 suggestions: ["pleroma"]
1062 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1063 suggestions: ["$metadata[$level] $message"]
1067 type: {:list, :atom},
1068 suggestions: [:request_id]
1076 label: "Console Logger",
1077 description: "Console logger settings",
1081 type: {:dropdown, :atom},
1082 description: "Log level",
1083 suggestions: [:debug, :info, :warn, :error]
1088 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1089 suggestions: ["$metadata[$level] $message"]
1093 type: {:list, :atom},
1094 suggestions: [:request_id]
1101 label: "Quack Logger",
1102 description: "Quack-related settings",
1106 type: {:dropdown, :atom},
1107 description: "Log level",
1108 suggestions: [:debug, :info, :warn, :error]
1112 type: {:list, :atom},
1113 description: "Configure which metadata you want to report on",
1130 label: "Webhook URL",
1132 description: "Configure the Slack incoming webhook",
1133 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1139 key: :frontend_configurations,
1142 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1143 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1144 "add your own configuration your settings all fields must be complete.",
1148 label: "Pleroma FE",
1150 description: "Settings for Pleroma FE",
1153 alwaysShowSubjectInput: true,
1154 background: "/static/aurora_borealis.jpg",
1155 collapseMessageWithSubject: false,
1158 hideFilteredStatuses: false,
1159 hideMutedPosts: false,
1160 hidePostStats: false,
1161 hideSitename: false,
1162 hideUserStats: false,
1163 loginMethod: "password",
1164 logo: "/static/logo.svg",
1167 minimalScopesMode: false,
1168 noAttachmentLinks: false,
1169 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1170 postContentType: "text/plain",
1171 redirectRootLogin: "/main/friends",
1172 redirectRootNoLogin: "/main/all",
1174 sidebarRight: false,
1175 showFeaturesPanel: true,
1176 showInstanceSpecificPanel: false,
1177 subjectLineBehavior: "email",
1178 theme: "pleroma-dark",
1179 webPushNotifications: false
1184 key: :alwaysShowSubjectInput,
1185 label: "Always show subject input",
1187 description: "When disabled, auto-hide the subject field if it's empty"
1191 type: {:string, :image},
1193 "URL of the background, unless viewing a user profile with a background that is set",
1194 suggestions: ["/images/city.jpg"]
1197 key: :collapseMessageWithSubject,
1198 label: "Collapse message with subject",
1201 "When a message has a subject (aka Content Warning), collapse it by default"
1205 label: "PleromaFE Chat",
1207 description: "Disables PleromaFE Chat component"
1213 description: "Enables green text on lines prefixed with the > character"
1216 key: :hideFilteredStatuses,
1217 label: "Hide Filtered Statuses",
1219 description: "Hides filtered statuses from timelines"
1222 key: :hideMutedPosts,
1223 label: "Hide Muted Posts",
1225 description: "Hides muted statuses from timelines"
1228 key: :hidePostStats,
1229 label: "Hide post stats",
1231 description: "Hide notices statistics (repeats, favorites, ...)"
1235 label: "Hide Sitename",
1237 description: "Hides instance name from PleromaFE banner"
1240 key: :hideUserStats,
1241 label: "Hide user stats",
1244 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1248 type: {:string, :image},
1249 description: "URL of the logo, defaults to Pleroma's logo",
1250 suggestions: ["/static/logo.svg"]
1254 label: "Logo margin",
1257 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1258 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1259 suggestions: [".1em"]
1266 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1267 "If you want a colorful logo you must disable logoMask."
1270 key: :minimalScopesMode,
1271 label: "Minimal scopes mode",
1274 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1275 "Also prevents replying to a DM with a public post from PleromaFE."
1278 key: :nsfwCensorImage,
1279 label: "NSFW Censor Image",
1280 type: {:string, :image},
1282 "URL of the image to use for hiding NSFW media attachments in the timeline",
1283 suggestions: ["/static/img/nsfw.74818f9.png"]
1286 key: :postContentType,
1287 label: "Post Content Type",
1288 type: {:dropdown, :atom},
1289 description: "Default post formatting option",
1290 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1293 key: :redirectRootNoLogin,
1294 label: "Redirect root no login",
1297 "Relative URL which indicates where to redirect when a user isn't logged in",
1298 suggestions: ["/main/all"]
1301 key: :redirectRootLogin,
1302 label: "Redirect root login",
1305 "Relative URL which indicates where to redirect when a user is logged in",
1306 suggestions: ["/main/friends"]
1310 label: "Scope copy",
1312 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1316 label: "Sidebar on Right",
1318 description: "Change alignment of sidebar and panels to the right"
1321 key: :showFeaturesPanel,
1322 label: "Show instance features panel",
1325 "Enables panel displaying functionality of the instance on the About page"
1328 key: :showInstanceSpecificPanel,
1329 label: "Show instance specific panel",
1331 description: "Whether to show the instance's custom panel"
1334 key: :subjectLineBehavior,
1335 label: "Subject line behavior",
1337 description: "Allows changing the default behaviour of subject lines in replies.
1338 `email`: copy and preprend re:, as in email,
1339 `masto`: copy verbatim, as in Mastodon,
1340 `noop`: don't copy the subject.",
1341 suggestions: ["email", "masto", "noop"]
1346 description: "Which theme to use. Available themes are defined in styles.json",
1347 suggestions: ["pleroma-dark"]
1355 description: "Settings for Masto FE",
1358 showInstanceSpecificPanel: true
1363 key: :showInstanceSpecificPanel,
1364 label: "Show instance specific panel",
1366 description: "Whenether to show the instance's specific panel"
1377 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1381 type: {:keyword, :map},
1383 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1386 url: "/images/pleroma-fox-tan-smol.png",
1387 mime_type: "image/png"
1389 pleroma_fox_tan_shy: %{
1390 url: "/images/pleroma-fox-tan-shy.png",
1391 mime_type: "image/png"
1396 key: :default_mascot,
1399 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1405 key: :default_user_avatar,
1406 type: {:string, :image},
1407 description: "URL of the default user avatar",
1408 suggestions: ["/images/avi.png"]
1417 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1421 type: {:list, :map},
1422 description: "Describe the icons of the app",
1425 src: "/static/logo.png"
1428 src: "/static/icon.png",
1432 src: "/static/icon.ico",
1433 sizes: "72x72 96x96 128x128 256x256"
1440 description: "Describe the theme color of the app",
1441 suggestions: ["#282c37", "mediumpurple"]
1444 key: :background_color,
1446 description: "Describe the background color of the app",
1447 suggestions: ["#191b22", "aliceblue"]
1455 description: "Media proxy",
1460 description: "Enables proxying of remote media via the instance's proxy"
1467 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1468 suggestions: ["https://example.com"]
1476 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1482 description: "Enables media cache object invalidation."
1487 description: "Module which will be used to purge objects from the cache.",
1489 Pleroma.Web.MediaProxy.Invalidation.Script,
1490 Pleroma.Web.MediaProxy.Invalidation.Http
1497 label: "Advanced MediaProxy Options",
1499 description: "Internal Pleroma.ReverseProxy settings",
1501 redirect_on_failure: false,
1502 max_body_length: 25 * 1_048_576,
1503 max_read_duration: 30_000
1507 key: :redirect_on_failure,
1510 Redirects the client to the origin server upon encountering HTTP errors.\n
1511 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1512 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1513 IP addresses of your users to the other servers, bypassing the MediaProxy.
1517 key: :max_body_length,
1519 description: "Maximum file size allowed through the Pleroma MediaProxy cache."
1522 key: :max_read_duration,
1524 description: "Timeout (in milliseconds) of GET request to the remote URI."
1530 type: {:list, :string},
1531 description: "List of hosts with scheme to bypass the MediaProxy",
1532 suggestions: ["http://example.com"]
1538 key: :media_preview_proxy,
1540 description: "Media preview proxy",
1546 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1549 key: :thumbnail_max_width,
1552 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1555 key: :thumbnail_max_height,
1558 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1561 key: :image_quality,
1563 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1566 key: :min_content_length,
1569 "Min content length to perform preview, in bytes. If greater than 0, media smaller in size will be served as is, without thumbnailing."
1575 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1577 description: "HTTP invalidate settings",
1582 description: "HTTP method of request. Default: :purge"
1586 type: {:keyword, :string},
1587 description: "HTTP headers of request",
1588 suggestions: [{"x-refresh", 1}]
1593 description: "Request options",
1597 type: {:map, :string}
1605 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1607 description: "Invalidation script settings",
1612 description: "Path to executable script which will purge cached items.",
1613 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1619 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1620 suggestions: [":htcacheclean"]
1628 description: "Gopher settings",
1633 description: "Enables the gopher interface"
1639 description: "IP address to bind to",
1640 suggestions: [{0, 0, 0, 0}]
1645 description: "Port to bind to",
1651 description: "Port advertised in URLs (optional, defaults to port)",
1659 label: "ActivityPub",
1661 description: "ActivityPub-related settings",
1664 key: :unfollow_blocked,
1666 description: "Whether blocks result in people getting unfollowed"
1669 key: :outgoing_blocks,
1671 description: "Whether to federate blocks to other instances"
1674 key: :sign_object_fetches,
1676 description: "Sign object fetches with HTTP signatures"
1679 key: :note_replies_output_limit,
1682 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1685 key: :follow_handshake_timeout,
1687 description: "Following handshake timeout",
1694 key: :http_security,
1695 label: "HTTP security",
1697 description: "HTTP security settings",
1702 description: "Whether the managed content security policy is enabled"
1708 description: "Whether to additionally send a Strict-Transport-Security header"
1712 label: "STS max age",
1714 description: "The maximum age for the Strict-Transport-Security header if sent",
1715 suggestions: [31_536_000]
1719 label: "CT max age",
1721 description: "The maximum age for the Expect-CT header if sent",
1722 suggestions: [2_592_000]
1725 key: :referrer_policy,
1727 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1728 suggestions: ["same-origin", "no-referrer"]
1732 label: "Report URI",
1734 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1735 suggestions: ["https://example.com/report-uri"]
1740 group: :web_push_encryption,
1741 key: :vapid_details,
1742 label: "Vapid Details",
1745 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1751 "A mailto link for the administrative contact." <>
1752 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1753 suggestions: ["mailto:moderators@pleroma.com"]
1758 description: "VAPID public key",
1759 suggestions: ["Public key"]
1764 description: "VAPID private key",
1765 suggestions: ["Private key"]
1771 key: Pleroma.Captcha,
1773 description: "Captcha-related settings",
1778 description: "Whether the captcha should be shown on registration"
1783 description: "The method/service to use for captcha",
1784 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1787 key: :seconds_valid,
1789 description: "The time in seconds for which the captcha is valid",
1796 key: Pleroma.Captcha.Kocaptcha,
1799 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1800 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1805 description: "The kocaptcha endpoint to use",
1806 suggestions: ["https://captcha.kotobank.ch"]
1812 label: "Pleroma Admin Token",
1815 "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)",
1820 description: "Admin token",
1822 "Please use a high entropy string or UUID"
1832 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1836 type: {:dropdown, :atom},
1837 description: "Logs verbose mode",
1838 suggestions: [false, :error, :warn, :info, :debug]
1842 type: {:keyword, :integer},
1844 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1846 activity_expiration: 10,
1847 attachments_cleanup: 5,
1849 federator_incoming: 50,
1850 federator_outgoing: 50,
1852 scheduled_activities: 10,
1858 key: :activity_expiration,
1860 description: "Activity expiration queue",
1866 description: "Backup queue",
1870 key: :attachments_cleanup,
1872 description: "Attachment deletion queue",
1878 description: "Background queue",
1882 key: :federator_incoming,
1884 description: "Incoming federation queue",
1888 key: :federator_outgoing,
1890 description: "Outgoing federation queue",
1896 description: "Email sender queue, see Pleroma.Emails.Mailer",
1900 key: :scheduled_activities,
1902 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1906 key: :transmogrifier,
1908 description: "Transmogrifier queue",
1914 description: "Web push notifications queue",
1921 type: {:list, :tuple},
1922 description: "Settings for cron background jobs",
1924 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1925 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1934 description: "Includes custom worker options not interpretable directly by `Oban`",
1938 type: {:keyword, :integer},
1939 description: "Max retry attempts for failed jobs, per `Oban` queue",
1941 federator_incoming: 5,
1942 federator_outgoing: 5
1949 key: Pleroma.Web.Metadata,
1951 description: "Metadata-related settings",
1955 type: {:list, :module},
1956 description: "List of metadata providers to enable",
1958 Pleroma.Web.Metadata.Providers.OpenGraph,
1959 Pleroma.Web.Metadata.Providers.TwitterCard,
1960 Pleroma.Web.Metadata.Providers.RelMe,
1961 Pleroma.Web.Metadata.Providers.Feed
1966 label: "Unfurl NSFW",
1968 description: "When enabled NSFW attachments will be shown in previews"
1977 "If enabled the instance will parse metadata from attached links to generate link previews",
1982 description: "Enables RichMedia parsing of URLs"
1986 type: {:list, :string},
1987 description: "List of hosts which will be ignored by the metadata parser",
1988 suggestions: ["accounts.google.com", "xss.website"]
1992 label: "Ignore TLD",
1993 type: {:list, :string},
1994 description: "List TLDs (top-level domains) which will ignore for parse metadata",
1995 suggestions: ["local", "localdomain", "lan"]
1999 type: {:list, :module},
2001 "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.",
2003 Pleroma.Web.RichMedia.Parsers.OEmbed,
2004 Pleroma.Web.RichMedia.Parsers.TwitterCard
2009 label: "TTL setters",
2010 type: {:list, :module},
2012 "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.",
2014 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2018 key: :failure_backoff,
2021 "Amount of milliseconds after request failure, during which the request will not be retried.",
2022 suggestions: [60_000]
2028 key: Pleroma.Formatter,
2032 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2036 type: [:string, :boolean],
2037 description: "Specify the class to be added to the generated link. Disable to clear.",
2038 suggestions: ["auto-linker", false]
2042 type: [:string, :boolean],
2043 description: "Override the rel attribute. Disable to clear.",
2044 suggestions: ["ugc", "noopener noreferrer", false]
2049 description: "Link URLs will open in a new window/tab."
2053 type: [:integer, :boolean],
2055 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2056 suggestions: [15, false]
2061 description: "Strip the scheme prefix."
2066 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2070 type: [:atom, :boolean],
2072 "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)",
2073 suggestions: [:no_scheme, true]
2079 key: Pleroma.ScheduledActivity,
2081 description: "Scheduled activities settings",
2084 key: :daily_user_limit,
2087 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2091 key: :total_user_limit,
2094 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2100 description: "Whether scheduled activities are sent to the job queue to be executed"
2106 key: Pleroma.Workers.PurgeExpiredActivity,
2108 description: "Expired activities settings",
2113 description: "Enables expired activities addition & deletion"
2118 description: "Minimum lifetime for ephemeral activity (in seconds)",
2125 label: "Pleroma Authenticator",
2127 description: "Authenticator",
2130 key: Pleroma.Web.Auth.Authenticator,
2132 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2142 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2143 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2144 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2145 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2150 description: "Enables LDAP authentication"
2155 description: "LDAP server hostname",
2156 suggestions: ["localhosts"]
2161 description: "LDAP port, e.g. 389 or 636",
2162 suggestions: [389, 636]
2168 description: "Enable to use SSL, usually implies the port 636"
2172 label: "SSL options",
2174 description: "Additional SSL options",
2175 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2180 description: "Path to file with PEM encoded cacerts",
2181 suggestions: ["path/to/file/with/PEM/cacerts"]
2186 description: "Type of cert verification",
2187 suggestions: [:verify_peer]
2195 description: "Enable to use STARTTLS, usually implies the port 389"
2199 label: "TLS options",
2201 description: "Additional TLS options",
2202 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2207 description: "Path to file with PEM encoded cacerts",
2208 suggestions: ["path/to/file/with/PEM/cacerts"]
2213 description: "Type of cert verification",
2214 suggestions: [:verify_peer]
2221 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2222 suggestions: ["dc=example,dc=com"]
2229 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2238 description: "Authentication / authorization settings",
2241 key: :enforce_oauth_admin_scope_usage,
2242 label: "Enforce OAuth admin scope usage",
2245 "OAuth admin scope requirement toggle. " <>
2246 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2247 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2248 "`is_admin` user flag grants access to admin-specific actions."
2251 key: :auth_template,
2254 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2255 suggestions: ["show.html"]
2258 key: :oauth_consumer_template,
2259 label: "OAuth consumer template",
2262 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2263 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2264 suggestions: ["consumer.html"]
2267 key: :oauth_consumer_strategies,
2268 label: "OAuth consumer strategies",
2269 type: {:list, :string},
2271 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2272 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2273 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2274 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2280 key: :email_notifications,
2282 description: "Email notifications settings",
2288 "emails of \"what you've missed\" for users who have been inactive for a while",
2292 schedule: "0 0 * * 0",
2294 inactivity_threshold: 7
2302 description: "Globally enable or disable digest emails"
2308 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2309 suggestions: ["0 0 * * 0"]
2314 description: "Minimum interval between digest emails to one user",
2318 key: :inactivity_threshold,
2320 description: "Minimum user inactivity threshold",
2329 key: Pleroma.Emails.UserEmail,
2331 description: "Email template settings",
2335 type: {:string, :image},
2336 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2337 suggestions: ["some/path/logo.png"]
2342 description: "A map with color settings for email templates.",
2345 link_color: "#d8a070",
2346 background_color: "#2C3645",
2347 content_background_color: "#1B2635",
2348 header_color: "#d8a070",
2349 text_color: "#b9b9ba",
2350 text_muted_color: "#b9b9ba"
2357 suggestions: ["#d8a070"]
2360 key: :background_color,
2362 suggestions: ["#2C3645"]
2365 key: :content_background_color,
2367 suggestions: ["#1B2635"]
2372 suggestions: ["#d8a070"]
2377 suggestions: ["#b9b9ba"]
2380 key: :text_muted_color,
2382 suggestions: ["#b9b9ba"]
2390 key: Pleroma.Emails.NewUsersDigestEmail,
2392 description: "New users admin email digest",
2397 description: "Enables new users admin digest email when `true`"
2406 description: "Configure OAuth 2 provider capabilities",
2409 key: :token_expires_in,
2411 description: "The lifetime in seconds of the access token",
2412 suggestions: [2_592_000]
2415 key: :issue_new_refresh_token,
2418 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2421 key: :clean_expired_tokens,
2423 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2433 key: :shortcode_globs,
2434 type: {:list, :string},
2435 description: "Location of custom emoji files. * can be used as a wildcard.",
2436 suggestions: ["/emoji/custom/**/*.png"]
2439 key: :pack_extensions,
2440 type: {:list, :string},
2442 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2443 suggestions: [".png", ".gif"]
2447 type: {:keyword, {:list, :string}},
2449 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2450 " and the value is the location or array of locations. * can be used as a wildcard.",
2452 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2456 key: :default_manifest,
2459 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2460 " Currently only one manifest can be added (no arrays).",
2461 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2464 key: :shared_pack_cache_seconds_per_file,
2465 label: "Shared pack cache s/file",
2468 "When an emoji pack is shared, the archive is created and cached in memory" <>
2469 " for this amount of seconds multiplied by the number of files.",
2479 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2483 type: [:tuple, {:list, :tuple}],
2484 description: "For the search requests (account & status search etc.)",
2485 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2489 type: [:tuple, {:list, :tuple}],
2490 description: "For requests to timelines (each timeline has it's own limiter)",
2491 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2494 key: :app_account_creation,
2495 type: [:tuple, {:list, :tuple}],
2496 description: "For registering user accounts from the same IP address",
2497 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2500 key: :relations_actions,
2501 type: [:tuple, {:list, :tuple}],
2502 description: "For actions on relationships with all users (follow, unfollow)",
2503 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2506 key: :relation_id_action,
2507 label: "Relation ID action",
2508 type: [:tuple, {:list, :tuple}],
2509 description: "For actions on relation with a specific user (follow, unfollow)",
2510 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2513 key: :statuses_actions,
2514 type: [:tuple, {:list, :tuple}],
2516 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2517 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2520 key: :status_id_action,
2521 label: "Status ID action",
2522 type: [:tuple, {:list, :tuple}],
2524 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2525 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2528 key: :authentication,
2529 type: [:tuple, {:list, :tuple}],
2530 description: "For authentication create / password check / user existence check requests",
2531 suggestions: [{60_000, 15}]
2540 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2541 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2546 description: "Enables SSH"
2551 description: "Dir with SSH keys",
2552 suggestions: ["/some/path/ssh_keys"]
2557 description: "Handler module",
2558 suggestions: ["Pleroma.BBS.Handler"]
2563 description: "Port to connect",
2564 suggestions: [10_022]
2567 key: :password_authenticator,
2569 description: "Authenticator module",
2570 suggestions: ["Pleroma.BBS.Authenticator"]
2576 label: "Mime Types",
2578 description: "Mime Types settings",
2585 "application/xml" => ["xml"],
2586 "application/xrd+xml" => ["xrd+xml"],
2587 "application/jrd+json" => ["jrd+json"],
2588 "application/activity+json" => ["activity+json"],
2589 "application/ld+json" => ["activity+json"]
2594 key: "application/xml",
2595 type: {:list, :string},
2596 suggestions: ["xml"]
2599 key: "application/xrd+xml",
2600 type: {:list, :string},
2601 suggestions: ["xrd+xml"]
2604 key: "application/jrd+json",
2605 type: {:list, :string},
2606 suggestions: ["jrd+json"]
2609 key: "application/activity+json",
2610 type: {:list, :string},
2611 suggestions: ["activity+json"]
2614 key: "application/ld+json",
2615 type: {:list, :string},
2616 suggestions: ["activity+json"]
2626 description: "Pleroma chat settings",
2639 description: "HTTP settings",
2644 type: [:string, :tuple],
2645 description: "Proxy URL",
2646 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2649 key: :send_user_agent,
2654 type: [:string, :atom],
2656 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2657 suggestions: ["Pleroma", :default]
2662 description: "Adapter specific options",
2668 label: "SSL Options",
2669 description: "SSL options for HTTP adapter",
2673 type: {:list, :atom},
2674 description: "List of TLS version to use",
2675 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2686 label: "Markup Settings",
2690 key: :allow_inline_images,
2694 key: :allow_headings,
2707 type: {:list, :module},
2709 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2710 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2720 key: :deny_follow_blocked,
2731 key: :restricted_nicknames,
2732 type: {:list, :string},
2733 description: "List of nicknames users may not register with.",
2752 "ostatus_subscribe",
2768 key: :email_blacklist,
2769 type: {:list, :string},
2770 description: "List of email domains users may not register with.",
2771 suggestions: ["mailinator.com", "maildrop.cc"]
2777 label: "CORS plug config",
2783 suggestions: [86_400]
2787 type: {:list, :string},
2788 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2792 type: {:list, :string},
2795 "X-RateLimit-Reset",
2796 "X-RateLimit-Limit",
2797 "X-RateLimit-Remaining",
2808 type: {:list, :string},
2809 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2815 key: Pleroma.Web.Plugs.RemoteIp,
2818 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2819 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2825 description: "Enable/disable the plug. Default: disabled."
2829 type: {:list, :string},
2831 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2836 type: {:list, :string},
2838 "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."
2842 type: {:list, :string},
2844 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"]`
2851 key: :web_cache_ttl,
2852 label: "Web cache TTL",
2855 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2861 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2862 suggestions: [30_000, nil]
2865 key: :activity_pub_question,
2867 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2868 suggestions: [30_000]
2878 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2883 description: "Enables the rendering of static HTML. Default: disabled."
2891 description: "Configure feed rendering",
2896 description: "Configure title rendering",
2901 description: "Maximum number of characters before truncating title",
2907 description: "Replacement which will be used after truncating string",
2908 suggestions: ["..."]
2918 description: "Custom Runtime Modules",
2923 description: "A path to custom Elixir modules (such as MRF policies)."
2931 description: "Settings for notifications streamer",
2936 description: "Number of workers to send notifications",
2940 key: :overflow_workers,
2942 description: "Maximum number of workers created if pool is empty",
2949 key: :connections_pool,
2951 description: "Advanced settings for `Gun` connections pool",
2954 key: :connection_acquisition_wait,
2957 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
2961 key: :connection_acquisition_retries,
2964 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
2968 key: :max_connections,
2970 description: "Maximum number of connections in the pool. Default: 250 connections.",
2974 key: :connect_timeout,
2976 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
2980 key: :reclaim_multiplier,
2983 "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",
2992 description: "Advanced settings for `Gun` workers pools",
2994 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
2998 description: "Settings for #{pool_name} pool.",
3003 description: "Maximum number of concurrent requests in the pool.",
3010 "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",
3016 description: "Timeout for the pool while gun will wait for response",
3017 suggestions: [10_000]
3025 key: :hackney_pools,
3027 description: "Advanced settings for `Hackney` connections pools",
3032 description: "Settings for federation pool.",
3035 key: :max_connections,
3037 description: "Number workers in the pool.",
3043 description: "Timeout while `hackney` will wait for response.",
3044 suggestions: [150_000]
3051 description: "Settings for media pool.",
3054 key: :max_connections,
3056 description: "Number workers in the pool.",
3062 description: "Timeout while `hackney` will wait for response.",
3063 suggestions: [150_000]
3070 description: "Settings for upload pool.",
3073 key: :max_connections,
3075 description: "Number workers in the pool.",
3081 description: "Timeout while `hackney` will wait for response.",
3082 suggestions: [300_000]
3090 key: :restrict_unauthenticated,
3091 label: "Restrict Unauthenticated",
3094 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3099 description: "Settings for public and federated timelines.",
3104 description: "Disallow view public timeline."
3109 description: "Disallow view federated timeline."
3116 description: "Settings for user profiles.",
3121 description: "Disallow view local user profiles."
3126 description: "Disallow view remote user profiles."
3133 description: "Settings for statuses.",
3138 description: "Disallow view local statuses."
3143 description: "Disallow view remote statuses."
3151 key: Pleroma.Web.ApiSpec.CastAndValidate,
3158 "Enables strict input validation (useful in development, not recommended in production)"
3164 key: :instances_favicons,
3166 description: "Control favicons for instances",
3171 description: "Allow/disallow displaying and getting instances favicons"
3179 descriptions: "S3 service related settings",
3182 key: :access_key_id,
3184 description: "S3 access key ID",
3185 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3188 key: :secret_access_key,
3190 description: "Secret access key",
3191 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3196 description: "S3 host",
3197 suggestions: ["s3.eu-central-1.amazonaws.com"]
3202 description: "S3 region (for AWS)",
3203 suggestions: ["us-east-1"]
3211 description: "Installed frontends management",
3216 description: "Primary frontend, the one that is served for all pages by default",
3217 children: installed_frontend_options
3222 description: "Admin frontend",
3223 children: installed_frontend_options
3229 "A map containing available frontends and parameters for their installation.",
3230 children: frontend_options
3236 key: Pleroma.Web.Preload,
3238 description: "Preload-related settings",
3242 type: {:list, :module},
3243 description: "List of preload providers to enable",
3245 Pleroma.Web.Preload.Providers.Instance,
3246 Pleroma.Web.Preload.Providers.User,
3247 Pleroma.Web.Preload.Providers.Timelines,
3248 Pleroma.Web.Preload.Providers.StatusNet
3257 description: "Majic/libmagic configuration",
3262 description: "Number of majic workers to start.",
3269 key: Pleroma.User.Backup,
3271 description: "Account Backup",
3274 key: :purge_after_days,
3276 description: "Remove backup achives after N days",
3282 description: "Limit user to export not more often than once per N days",
3289 key: Pleroma.Web.Endpoint.MetricsExporter,
3291 description: "Prometheus app metrics endpoint configuration",
3296 description: "[Pleroma extension] Enables app metrics endpoint."
3300 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3302 "[Pleroma extension] If non-empty, restricts access to app metrics endpoint to specified IP addresses."
3306 type: [:boolean, :tuple],
3307 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3308 suggestion: [false, {:basic, "myusername", "mypassword"}]
3313 description: "App metrics endpoint URI path.",
3314 suggestions: ["/api/pleroma/app_metrics"]
3319 description: "App metrics endpoint output format.",
3320 suggestions: [:text, :protobuf]
3326 key: ConcurrentLimiter,
3328 description: "Limits configuration for background tasks.",
3331 key: Pleroma.Web.RichMedia.Helpers,
3333 description: "Concurrent limits configuration for getting RichMedia for activities.",
3334 suggestions: [max_running: 5, max_waiting: 5],
3339 description: "Max running concurrently jobs.",
3345 description: "Max waiting jobs.",
3351 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3353 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3354 suggestions: [max_running: 5, max_waiting: 5],
3359 description: "Max running concurrently jobs.",
3365 description: "Max waiting jobs.",