projects / akkoma / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Merge branch 'dkuku-develop-patch-66061' into 'develop'
[akkoma] / config / description.exs
1 import Config
2
3 websocket_config = [
4 path: "/websocket",
5 serializer: [
6 {Phoenix.Socket.V1.JSONSerializer, "~> 1.0.0"},
7 {Phoenix.Socket.V2.JSONSerializer, "~> 2.0.0"}
8 ],
9 timeout: 60_000,
10 transport_log: false,
11 compress: false
12 ]
13
14 installed_frontend_options = [
15 %{
16 key: "name",
17 label: "Name",
18 type: :string,
19 description:
20 "Name of the installed frontend. Valid config must include both `Name` and `Reference` values."
21 },
22 %{
23 key: "ref",
24 label: "Reference",
25 type: :string,
26 description:
27 "Reference of the installed frontend to be used. Valid config must include both `Name` and `Reference` values."
28 }
29 ]
30
31 frontend_options = [
32 %{
33 key: "name",
34 label: "Name",
35 type: :string,
36 description: "Name of the frontend."
37 },
38 %{
39 key: "ref",
40 label: "Reference",
41 type: :string,
42 description: "Reference of the frontend to be used."
43 },
44 %{
45 key: "git",
46 label: "Git Repository URL",
47 type: :string,
48 description: "URL of the git repository of the frontend"
49 },
50 %{
51 key: "build_url",
52 label: "Build URL",
53 type: :string,
54 description:
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"
57 },
58 %{
59 key: "build_dir",
60 label: "Build directory",
61 type: :string,
62 description: "The directory inside the zip file "
63 },
64 %{
65 key: "custom-http-headers",
66 label: "Custom HTTP headers",
67 type: {:list, :string},
68 description: "The custom HTTP headers for the frontend"
69 }
70 ]
71
72 config :pleroma, :config_description, [
73 %{
74 group: :pleroma,
75 key: Pleroma.Upload,
76 type: :group,
77 description: "Upload general settings",
78 children: [
79 %{
80 key: :uploader,
81 type: :module,
82 description: "Module which will be used for uploads",
83 suggestions: {:list_behaviour_implementations, Pleroma.Uploaders.Uploader}
84 },
85 %{
86 key: :filters,
87 type: {:list, :module},
88 description:
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}
91 },
92 %{
93 key: :link_name,
94 type: :boolean,
95 description:
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`."
97 },
98 %{
99 key: :base_url,
100 label: "Base URL",
101 type: :string,
102 description:
103 "Base URL for the uploads. Required if you use a CDN or host attachments under a different domain.",
104 suggestions: [
105 "https://cdn-host.com"
106 ]
107 },
108 %{
109 key: :proxy_remote,
110 type: :boolean,
111 description: """
112 Proxy requests to the remote uploader.\n
113 Useful if media upload endpoint is not internet accessible.
114 """
115 },
116 %{
117 key: :filename_display_max_length,
118 type: :integer,
119 description: "Set max length of a filename to display. 0 = no limit. Default: 30"
120 }
121 ]
122 },
123 %{
124 group: :pleroma,
125 key: Pleroma.Uploaders.Local,
126 type: :group,
127 description: "Local uploader-related settings",
128 children: [
129 %{
130 key: :uploads,
131 type: :string,
132 description: "Path where user's uploads will be saved",
133 suggestions: [
134 "uploads"
135 ]
136 }
137 ]
138 },
139 %{
140 group: :pleroma,
141 key: Pleroma.Uploaders.S3,
142 type: :group,
143 description: "S3 uploader-related settings",
144 children: [
145 %{
146 key: :bucket,
147 type: :string,
148 description: "S3 bucket",
149 suggestions: [
150 "bucket"
151 ]
152 },
153 %{
154 key: :bucket_namespace,
155 type: :string,
156 description: "S3 bucket namespace",
157 suggestions: ["pleroma"]
158 },
159 %{
160 key: :truncated_namespace,
161 type: :string,
162 description:
163 "If you use S3 compatible service such as Digital Ocean Spaces or CDN, set folder name or \"\" etc." <>
164 " For example, when using CDN to S3 virtual host format, set \"\". At this time, write CNAME to CDN in Upload base_url."
165 },
166 %{
167 key: :streaming_enabled,
168 type: :boolean,
169 description:
170 "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."
171 }
172 ]
173 },
174 %{
175 group: :pleroma,
176 key: Pleroma.Upload.Filter.Mogrify,
177 type: :group,
178 description: "Uploads mogrify filter settings",
179 children: [
180 %{
181 key: :args,
182 type: [:string, {:list, :string}, {:list, :tuple}],
183 description:
184 "List of actions for the mogrify command. It's possible to add self-written settings as string. " <>
185 "For example `auto-orient, strip, {\"resize\", \"3840x1080>\"}` value will be parsed into valid list of the settings.",
186 suggestions: [
187 "strip",
188 "auto-orient",
189 {"implode", "1"}
190 ]
191 }
192 ]
193 },
194 %{
195 group: :pleroma,
196 key: Pleroma.Upload.Filter.AnonymizeFilename,
197 type: :group,
198 description: "Filter replaces the filename of the upload",
199 children: [
200 %{
201 key: :text,
202 type: :string,
203 description:
204 "Text to replace filenames in links. If no setting, {random}.extension will be used. You can get the original" <>
205 " filename extension by using {extension}, for example custom-file-name.{extension}.",
206 suggestions: [
207 "custom-file-name.{extension}"
208 ]
209 }
210 ]
211 },
212 %{
213 group: :pleroma,
214 key: Pleroma.Emails.Mailer,
215 type: :group,
216 description: "Mailer-related settings",
217 children: [
218 %{
219 key: :enabled,
220 label: "Mailer Enabled",
221 type: :boolean
222 },
223 %{
224 key: :adapter,
225 type: :module,
226 description:
227 "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
228 suggestions: [
229 Swoosh.Adapters.AmazonSES,
230 Swoosh.Adapters.Dyn,
231 Swoosh.Adapters.Gmail,
232 Swoosh.Adapters.Mailgun,
233 Swoosh.Adapters.Mailjet,
234 Swoosh.Adapters.Mandrill,
235 Swoosh.Adapters.Postmark,
236 Swoosh.Adapters.SMTP,
237 Swoosh.Adapters.Sendgrid,
238 Swoosh.Adapters.Sendmail,
239 Swoosh.Adapters.SocketLabs,
240 Swoosh.Adapters.SparkPost
241 ]
242 },
243 %{
244 group: {:subgroup, Swoosh.Adapters.SMTP},
245 key: :relay,
246 type: :string,
247 description: "Hostname or IP address",
248 suggestions: ["smtp.example.com"]
249 },
250 %{
251 group: {:subgroup, Swoosh.Adapters.SMTP},
252 key: :port,
253 type: :integer,
254 description: "SMTP port",
255 suggestions: ["1025"]
256 },
257 %{
258 group: {:subgroup, Swoosh.Adapters.SMTP},
259 key: :username,
260 type: :string,
261 description: "SMTP AUTH username",
262 suggestions: ["user@example.com"]
263 },
264 %{
265 group: {:subgroup, Swoosh.Adapters.SMTP},
266 key: :password,
267 type: :string,
268 description: "SMTP AUTH password",
269 suggestions: ["password"]
270 },
271 %{
272 group: {:subgroup, Swoosh.Adapters.SMTP},
273 key: :ssl,
274 label: "Use SSL",
275 type: :boolean,
276 description: "Use Implicit SSL/TLS. e.g. port 465"
277 },
278 %{
279 group: {:subgroup, Swoosh.Adapters.SMTP},
280 key: :tls,
281 label: "STARTTLS Mode",
282 type: {:dropdown, :atom},
283 description: "Explicit TLS (STARTTLS) enforcement mode",
284 suggestions: [:if_available, :always, :never]
285 },
286 %{
287 group: {:subgroup, Swoosh.Adapters.SMTP},
288 key: :auth,
289 label: "AUTH Mode",
290 type: {:dropdown, :atom},
291 description: "SMTP AUTH enforcement mode",
292 suggestions: [:if_available, :always, :never]
293 },
294 %{
295 group: {:subgroup, Swoosh.Adapters.SMTP},
296 key: :retries,
297 type: :integer,
298 description: "SMTP temporary (4xx) error retries",
299 suggestions: [1]
300 },
301 %{
302 group: {:subgroup, Swoosh.Adapters.Sendgrid},
303 key: :api_key,
304 label: "SendGrid API Key",
305 type: :string,
306 suggestions: ["YOUR_API_KEY"]
307 },
308 %{
309 group: {:subgroup, Swoosh.Adapters.Sendmail},
310 key: :cmd_path,
311 type: :string,
312 suggestions: ["/usr/bin/sendmail"]
313 },
314 %{
315 group: {:subgroup, Swoosh.Adapters.Sendmail},
316 key: :cmd_args,
317 type: :string,
318 suggestions: ["-N delay,failure,success"]
319 },
320 %{
321 group: {:subgroup, Swoosh.Adapters.Sendmail},
322 key: :qmail,
323 label: "Qmail compat mode",
324 type: :boolean
325 },
326 %{
327 group: {:subgroup, Swoosh.Adapters.Mandrill},
328 key: :api_key,
329 label: "Mandrill API Key",
330 type: :string,
331 suggestions: ["YOUR_API_KEY"]
332 },
333 %{
334 group: {:subgroup, Swoosh.Adapters.Mailgun},
335 key: :api_key,
336 label: "Mailgun API Key",
337 type: :string,
338 suggestions: ["YOUR_API_KEY"]
339 },
340 %{
341 group: {:subgroup, Swoosh.Adapters.Mailgun},
342 key: :domain,
343 type: :string,
344 suggestions: ["YOUR_DOMAIN_NAME"]
345 },
346 %{
347 group: {:subgroup, Swoosh.Adapters.Mailjet},
348 key: :api_key,
349 label: "MailJet Public API Key",
350 type: :string,
351 suggestions: ["MJ_APIKEY_PUBLIC"]
352 },
353 %{
354 group: {:subgroup, Swoosh.Adapters.Mailjet},
355 key: :secret,
356 label: "MailJet Private API Key",
357 type: :string,
358 suggestions: ["MJ_APIKEY_PRIVATE"]
359 },
360 %{
361 group: {:subgroup, Swoosh.Adapters.Postmark},
362 key: :api_key,
363 label: "Postmark API Key",
364 type: :string,
365 suggestions: ["X-Postmark-Server-Token"]
366 },
367 %{
368 group: {:subgroup, Swoosh.Adapters.SparkPost},
369 key: :api_key,
370 label: "SparkPost API key",
371 type: :string,
372 suggestions: ["YOUR_API_KEY"]
373 },
374 %{
375 group: {:subgroup, Swoosh.Adapters.SparkPost},
376 key: :endpoint,
377 type: :string,
378 suggestions: ["https://api.sparkpost.com/api/v1"]
379 },
380 %{
381 group: {:subgroup, Swoosh.Adapters.AmazonSES},
382 key: :access_key,
383 label: "AWS Access Key",
384 type: :string,
385 suggestions: ["AWS_ACCESS_KEY"]
386 },
387 %{
388 group: {:subgroup, Swoosh.Adapters.AmazonSES},
389 key: :secret,
390 label: "AWS Secret Key",
391 type: :string,
392 suggestions: ["AWS_SECRET_KEY"]
393 },
394 %{
395 group: {:subgroup, Swoosh.Adapters.AmazonSES},
396 key: :region,
397 label: "AWS Region",
398 type: :string,
399 suggestions: ["us-east-1", "us-east-2"]
400 },
401 %{
402 group: {:subgroup, Swoosh.Adapters.Dyn},
403 key: :api_key,
404 label: "Dyn API Key",
405 type: :string,
406 suggestions: ["apikey"]
407 },
408 %{
409 group: {:subgroup, Swoosh.Adapters.SocketLabs},
410 key: :api_key,
411 label: "SocketLabs API Key",
412 type: :string,
413 suggestions: ["INJECTION_API_KEY"]
414 },
415 %{
416 group: {:subgroup, Swoosh.Adapters.SocketLabs},
417 key: :server_id,
418 label: "Server ID",
419 type: :string,
420 suggestions: ["SERVER_ID"]
421 },
422 %{
423 group: {:subgroup, Swoosh.Adapters.Gmail},
424 key: :access_token,
425 label: "GMail API Access Token",
426 type: :string,
427 suggestions: ["GMAIL_API_ACCESS_TOKEN"]
428 }
429 ]
430 },
431 %{
432 group: :pleroma,
433 key: :uri_schemes,
434 label: "URI Schemes",
435 type: :group,
436 description: "URI schemes related settings",
437 children: [
438 %{
439 key: :valid_schemes,
440 type: {:list, :string},
441 description: "List of the scheme part that is considered valid to be an URL",
442 suggestions: [
443 "https",
444 "http",
445 "dat",
446 "dweb",
447 "gopher",
448 "hyper",
449 "ipfs",
450 "ipns",
451 "irc",
452 "ircs",
453 "magnet",
454 "mailto",
455 "mumble",
456 "ssb",
457 "xmpp"
458 ]
459 }
460 ]
461 },
462 %{
463 group: :pleroma,
464 key: :features,
465 type: :group,
466 description: "Customizable features",
467 children: [
468 %{
469 key: :improved_hashtag_timeline,
470 type: {:dropdown, :atom},
471 description:
472 "Setting to force toggle / force disable improved hashtags timeline. `:enabled` forces hashtags to be fetched from `hashtags` table for hashtags timeline. `:disabled` forces object-embedded hashtags to be used (slower). Keep it `:auto` for automatic behaviour (it is auto-set to `:enabled` [unless overridden] when HashtagsTableMigrator completes).",
473 suggestions: [:auto, :enabled, :disabled]
474 }
475 ]
476 },
477 %{
478 group: :pleroma,
479 key: :populate_hashtags_table,
480 type: :group,
481 description: "`populate_hashtags_table` background migration settings",
482 children: [
483 %{
484 key: :fault_rate_allowance,
485 type: :float,
486 description:
487 "Max accepted rate of objects that failed in the migration. Any value from 0.0 which tolerates no errors to 1.0 which will enable the feature even if hashtags transfer failed for all records.",
488 suggestions: [0.01]
489 },
490 %{
491 key: :sleep_interval_ms,
492 type: :integer,
493 description:
494 "Sleep interval between each chunk of processed records in order to decrease the load on the system (defaults to 0 and should be keep default on most instances)."
495 }
496 ]
497 },
498 %{
499 group: :pleroma,
500 key: :instance,
501 type: :group,
502 description: "Instance-related settings",
503 children: [
504 %{
505 key: :name,
506 type: :string,
507 description: "Name of the instance",
508 suggestions: [
509 "Pleroma"
510 ]
511 },
512 %{
513 key: :email,
514 label: "Admin Email Address",
515 type: :string,
516 description: "Email used to reach an Administrator/Moderator of the instance",
517 suggestions: [
518 "email@example.com"
519 ]
520 },
521 %{
522 key: :notify_email,
523 label: "Sender Email Address",
524 type: :string,
525 description: "Envelope FROM address for mail sent via Pleroma",
526 suggestions: [
527 "notify@example.com"
528 ]
529 },
530 %{
531 key: :description,
532 type: :string,
533 description:
534 "The instance's description. It can be seen in nodeinfo and `/api/v1/instance`",
535 suggestions: [
536 "Very cool instance"
537 ]
538 },
539 %{
540 key: :limit,
541 type: :integer,
542 description: "Posts character limit (CW/Subject included in the counter)",
543 suggestions: [
544 5_000
545 ]
546 },
547 %{
548 key: :remote_limit,
549 type: :integer,
550 description: "Hard character limit beyond which remote posts will be dropped",
551 suggestions: [
552 100_000
553 ]
554 },
555 %{
556 key: :upload_limit,
557 type: :integer,
558 description: "File size limit of uploads (except for avatar, background, banner)",
559 suggestions: [
560 16_000_000
561 ]
562 },
563 %{
564 key: :avatar_upload_limit,
565 type: :integer,
566 description: "File size limit of user's profile avatars",
567 suggestions: [
568 2_000_000
569 ]
570 },
571 %{
572 key: :background_upload_limit,
573 type: :integer,
574 description: "File size limit of user's profile backgrounds",
575 suggestions: [
576 4_000_000
577 ]
578 },
579 %{
580 key: :banner_upload_limit,
581 type: :integer,
582 description: "File size limit of user's profile banners",
583 suggestions: [
584 4_000_000
585 ]
586 },
587 %{
588 key: :poll_limits,
589 type: :map,
590 description: "A map with poll limits for local polls",
591 suggestions: [
592 %{
593 max_options: 20,
594 max_option_chars: 200,
595 min_expiration: 0,
596 max_expiration: 31_536_000
597 }
598 ],
599 children: [
600 %{
601 key: :max_options,
602 type: :integer,
603 description: "Maximum number of options",
604 suggestions: [20]
605 },
606 %{
607 key: :max_option_chars,
608 type: :integer,
609 description: "Maximum number of characters per option",
610 suggestions: [200]
611 },
612 %{
613 key: :min_expiration,
614 type: :integer,
615 description: "Minimum expiration time (in seconds)",
616 suggestions: [0]
617 },
618 %{
619 key: :max_expiration,
620 type: :integer,
621 description: "Maximum expiration time (in seconds)",
622 suggestions: [3600]
623 }
624 ]
625 },
626 %{
627 key: :registrations_open,
628 type: :boolean,
629 description:
630 "Enable registrations for anyone. Invitations require this setting to be disabled."
631 },
632 %{
633 key: :invites_enabled,
634 type: :boolean,
635 description:
636 "Enable user invitations for admins (depends on `registrations_open` being disabled)"
637 },
638 %{
639 key: :account_activation_required,
640 type: :boolean,
641 description: "Require users to confirm their emails before signing in"
642 },
643 %{
644 key: :account_approval_required,
645 type: :boolean,
646 description: "Require users to be manually approved by an admin before signing in"
647 },
648 %{
649 key: :federating,
650 type: :boolean,
651 description: "Enable federation with other instances"
652 },
653 %{
654 key: :federation_incoming_replies_max_depth,
655 label: "Fed. incoming replies max depth",
656 type: :integer,
657 description:
658 "Max. depth of reply-to and reply activities fetching on incoming federation, to prevent out-of-memory situations while" <>
659 " 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.",
660 suggestions: [
661 100
662 ]
663 },
664 %{
665 key: :federation_reachability_timeout_days,
666 label: "Fed. reachability timeout days",
667 type: :integer,
668 description:
669 "Timeout (in days) of each external federation target being unreachable prior to pausing federating to it",
670 suggestions: [
671 7
672 ]
673 },
674 %{
675 key: :allow_relay,
676 type: :boolean,
677 description:
678 "Permits remote instances to subscribe to all public posts of your instance. (Important!) This may increase the visibility of your instance."
679 },
680 %{
681 key: :public,
682 type: :boolean,
683 description:
684 "Makes the client API in authenticated mode-only except for user-profiles." <>
685 " Useful for disabling the Local Timeline and The Whole Known Network. " <>
686 " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting."
687 },
688 %{
689 key: :quarantined_instances,
690 type: {:list, :tuple},
691 key_placeholder: "instance",
692 value_placeholder: "reason",
693 description:
694 "List of ActivityPub instances where private (DMs, followers-only) activities will not be sent and the reason for doing so",
695 suggestions: [
696 {"quarantined.com", "Reason"},
697 {"*.quarantined.com", "Reason"}
698 ]
699 },
700 %{
701 key: :static_dir,
702 type: :string,
703 description: "Instance static directory",
704 suggestions: [
705 "instance/static/"
706 ]
707 },
708 %{
709 key: :allowed_post_formats,
710 type: {:list, :string},
711 description: "MIME-type list of formats allowed to be posted (transformed into HTML)",
712 suggestions: [
713 "text/plain",
714 "text/html",
715 "text/markdown",
716 "text/bbcode"
717 ]
718 },
719 %{
720 key: :extended_nickname_format,
721 type: :boolean,
722 description:
723 "Enable to use extended local nicknames format (allows underscores/dashes)." <>
724 " This will break federation with older software for theses nicknames."
725 },
726 %{
727 key: :cleanup_attachments,
728 type: :boolean,
729 description: """
730 Enable to remove associated attachments when status is removed.
731 This will not affect duplicates and attachments without status.
732 Enabling this will increase load to database when deleting statuses on larger instances.
733 """
734 },
735 %{
736 key: :max_pinned_statuses,
737 type: :integer,
738 description: "The maximum number of pinned statuses. 0 will disable the feature.",
739 suggestions: [
740 0,
741 1,
742 3
743 ]
744 },
745 %{
746 key: :autofollowed_nicknames,
747 type: {:list, :string},
748 description:
749 "Set to nicknames of (local) users that every new user should automatically follow"
750 },
751 %{
752 key: :autofollowing_nicknames,
753 type: {:list, :string},
754 description:
755 "Set to nicknames of (local) users that automatically follows every newly registered user"
756 },
757 %{
758 key: :attachment_links,
759 type: :boolean,
760 description: "Enable to automatically add attachment link text to statuses"
761 },
762 %{
763 key: :max_report_comment_size,
764 type: :integer,
765 description: "The maximum size of the report comment. Default: 1000.",
766 suggestions: [
767 1_000
768 ]
769 },
770 %{
771 key: :safe_dm_mentions,
772 label: "Safe DM mentions",
773 type: :boolean,
774 description:
775 "If enabled, only mentions at the beginning of a post will be used to address people in direct messages." <>
776 " This is to prevent accidental mentioning of people when talking about them (e.g. \"@admin please keep an eye on @bad_actor\")." <>
777 " Default: disabled"
778 },
779 %{
780 key: :healthcheck,
781 type: :boolean,
782 description: "If enabled, system data will be shown on `/api/pleroma/healthcheck`"
783 },
784 %{
785 key: :remote_post_retention_days,
786 type: :integer,
787 description:
788 "The default amount of days to retain remote posts when pruning the database",
789 suggestions: [
790 90
791 ]
792 },
793 %{
794 key: :user_bio_length,
795 type: :integer,
796 description: "A user bio maximum length. Default: 5000.",
797 suggestions: [
798 5_000
799 ]
800 },
801 %{
802 key: :user_name_length,
803 type: :integer,
804 description: "A user name maximum length. Default: 100.",
805 suggestions: [
806 100
807 ]
808 },
809 %{
810 key: :skip_thread_containment,
811 type: :boolean,
812 description: "Skip filtering out broken threads. Default: enabled."
813 },
814 %{
815 key: :limit_to_local_content,
816 type: {:dropdown, :atom},
817 description:
818 "Limit unauthenticated users to search for local statutes and users only. Default: `:unauthenticated`.",
819 suggestions: [
820 :unauthenticated,
821 :all,
822 false
823 ]
824 },
825 %{
826 key: :max_account_fields,
827 type: :integer,
828 description: "The maximum number of custom fields in the user profile. Default: 10.",
829 suggestions: [
830 10
831 ]
832 },
833 %{
834 key: :max_remote_account_fields,
835 type: :integer,
836 description:
837 "The maximum number of custom fields in the remote user profile. Default: 20.",
838 suggestions: [
839 20
840 ]
841 },
842 %{
843 key: :account_field_name_length,
844 type: :integer,
845 description: "An account field name maximum length. Default: 512.",
846 suggestions: [
847 512
848 ]
849 },
850 %{
851 key: :account_field_value_length,
852 type: :integer,
853 description: "An account field value maximum length. Default: 2048.",
854 suggestions: [
855 2048
856 ]
857 },
858 %{
859 key: :registration_reason_length,
860 type: :integer,
861 description: "Maximum registration reason length. Default: 500.",
862 suggestions: [
863 500
864 ]
865 },
866 %{
867 key: :external_user_synchronization,
868 type: :boolean,
869 description: "Enabling following/followers counters synchronization for external users"
870 },
871 %{
872 key: :multi_factor_authentication,
873 type: :keyword,
874 description: "Multi-factor authentication settings",
875 suggestions: [
876 [
877 totp: [digits: 6, period: 30],
878 backup_codes: [number: 5, length: 16]
879 ]
880 ],
881 children: [
882 %{
883 key: :totp,
884 label: "TOTP settings",
885 type: :keyword,
886 description: "TOTP settings",
887 suggestions: [digits: 6, period: 30],
888 children: [
889 %{
890 key: :digits,
891 type: :integer,
892 suggestions: [6],
893 description:
894 "Determines the length of a one-time pass-code, in characters. Defaults to 6 characters."
895 },
896 %{
897 key: :period,
898 type: :integer,
899 suggestions: [30],
900 description:
901 "A period for which the TOTP code will be valid, in seconds. Defaults to 30 seconds."
902 }
903 ]
904 },
905 %{
906 key: :backup_codes,
907 type: :keyword,
908 description: "MFA backup codes settings",
909 suggestions: [number: 5, length: 16],
910 children: [
911 %{
912 key: :number,
913 type: :integer,
914 suggestions: [5],
915 description: "Number of backup codes to generate."
916 },
917 %{
918 key: :length,
919 type: :integer,
920 suggestions: [16],
921 description:
922 "Determines the length of backup one-time pass-codes, in characters. Defaults to 16 characters."
923 }
924 ]
925 }
926 ]
927 },
928 %{
929 key: :instance_thumbnail,
930 type: {:string, :image},
931 description:
932 "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.",
933 suggestions: ["/instance/thumbnail.jpeg"]
934 },
935 %{
936 key: :show_reactions,
937 type: :boolean,
938 description: "Let favourites and emoji reactions be viewed through the API."
939 }
940 ]
941 },
942 %{
943 group: :pleroma,
944 key: :welcome,
945 type: :group,
946 description: "Welcome messages settings",
947 children: [
948 %{
949 key: :direct_message,
950 type: :keyword,
951 descpiption: "Direct message settings",
952 children: [
953 %{
954 key: :enabled,
955 type: :boolean,
956 description: "Enables sending a direct message to newly registered users"
957 },
958 %{
959 key: :message,
960 type: :string,
961 description: "A message that will be sent to newly registered users",
962 suggestions: [
963 "Hi, @username! Welcome on board!"
964 ]
965 },
966 %{
967 key: :sender_nickname,
968 type: :string,
969 description: "The nickname of the local user that sends a welcome message",
970 suggestions: [
971 "lain"
972 ]
973 }
974 ]
975 },
976 %{
977 key: :chat_message,
978 type: :keyword,
979 descpiption: "Chat message settings",
980 children: [
981 %{
982 key: :enabled,
983 type: :boolean,
984 description: "Enables sending a chat message to newly registered users"
985 },
986 %{
987 key: :message,
988 type: :string,
989 description:
990 "A message that will be sent to newly registered users as a chat message",
991 suggestions: [
992 "Hello, welcome on board!"
993 ]
994 },
995 %{
996 key: :sender_nickname,
997 type: :string,
998 description: "The nickname of the local user that sends a welcome chat message",
999 suggestions: [
1000 "lain"
1001 ]
1002 }
1003 ]
1004 },
1005 %{
1006 key: :email,
1007 type: :keyword,
1008 descpiption: "Email message settings",
1009 children: [
1010 %{
1011 key: :enabled,
1012 type: :boolean,
1013 description: "Enables sending an email to newly registered users"
1014 },
1015 %{
1016 key: :sender,
1017 type: [:string, :tuple],
1018 description:
1019 "Email address and/or nickname that will be used to send the welcome email.",
1020 suggestions: [
1021 {"Pleroma App", "welcome@pleroma.app"}
1022 ]
1023 },
1024 %{
1025 key: :subject,
1026 type: :string,
1027 description:
1028 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1029 suggestions: ["Welcome to <%= instance_name%>"]
1030 },
1031 %{
1032 key: :html,
1033 type: :string,
1034 description:
1035 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1036 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1037 },
1038 %{
1039 key: :text,
1040 type: :string,
1041 description:
1042 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1043 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1044 }
1045 ]
1046 }
1047 ]
1048 },
1049 %{
1050 group: :logger,
1051 type: :group,
1052 description: "Logger-related settings",
1053 children: [
1054 %{
1055 key: :backends,
1056 type: [:atom, :tuple, :module],
1057 description:
1058 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1059 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1060 }
1061 ]
1062 },
1063 %{
1064 group: :logger,
1065 type: :group,
1066 key: :ex_syslogger,
1067 label: "ExSyslogger",
1068 description: "ExSyslogger-related settings",
1069 children: [
1070 %{
1071 key: :level,
1072 type: {:dropdown, :atom},
1073 description: "Log level",
1074 suggestions: [:debug, :info, :warn, :error]
1075 },
1076 %{
1077 key: :ident,
1078 type: :string,
1079 description:
1080 "A string that's prepended to every message, and is typically set to the app name",
1081 suggestions: ["pleroma"]
1082 },
1083 %{
1084 key: :format,
1085 type: :string,
1086 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1087 suggestions: ["$metadata[$level] $message"]
1088 },
1089 %{
1090 key: :metadata,
1091 type: {:list, :atom},
1092 suggestions: [:request_id]
1093 }
1094 ]
1095 },
1096 %{
1097 group: :logger,
1098 type: :group,
1099 key: :console,
1100 label: "Console Logger",
1101 description: "Console logger settings",
1102 children: [
1103 %{
1104 key: :level,
1105 type: {:dropdown, :atom},
1106 description: "Log level",
1107 suggestions: [:debug, :info, :warn, :error]
1108 },
1109 %{
1110 key: :format,
1111 type: :string,
1112 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1113 suggestions: ["$metadata[$level] $message"]
1114 },
1115 %{
1116 key: :metadata,
1117 type: {:list, :atom},
1118 suggestions: [:request_id]
1119 }
1120 ]
1121 },
1122 %{
1123 group: :quack,
1124 type: :group,
1125 label: "Quack Logger",
1126 description: "Quack-related settings",
1127 children: [
1128 %{
1129 key: :level,
1130 type: {:dropdown, :atom},
1131 description: "Log level",
1132 suggestions: [:debug, :info, :warn, :error]
1133 },
1134 %{
1135 key: :meta,
1136 type: {:list, :atom},
1137 description: "Configure which metadata you want to report on",
1138 suggestions: [
1139 :application,
1140 :module,
1141 :file,
1142 :function,
1143 :line,
1144 :pid,
1145 :crash_reason,
1146 :initial_call,
1147 :registered_name,
1148 :all,
1149 :none
1150 ]
1151 },
1152 %{
1153 key: :webhook_url,
1154 label: "Webhook URL",
1155 type: :string,
1156 description: "Configure the Slack incoming webhook",
1157 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1158 }
1159 ]
1160 },
1161 %{
1162 group: :pleroma,
1163 key: :frontend_configurations,
1164 type: :group,
1165 description:
1166 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1167 "kind of frontend. By default, settings for pleroma_fe and masto_fe are configured. If you want to " <>
1168 "add your own configuration your settings all fields must be complete.",
1169 children: [
1170 %{
1171 key: :pleroma_fe,
1172 label: "Pleroma FE",
1173 type: :map,
1174 description: "Settings for Pleroma FE",
1175 suggestions: [
1176 %{
1177 alwaysShowSubjectInput: true,
1178 background: "/static/aurora_borealis.jpg",
1179 collapseMessageWithSubject: false,
1180 greentext: false,
1181 hideFilteredStatuses: false,
1182 hideMutedPosts: false,
1183 hidePostStats: false,
1184 hideSitename: false,
1185 hideUserStats: false,
1186 loginMethod: "password",
1187 logo: "/static/logo.svg",
1188 logoMargin: ".1em",
1189 logoMask: true,
1190 minimalScopesMode: false,
1191 noAttachmentLinks: false,
1192 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1193 postContentType: "text/plain",
1194 redirectRootLogin: "/main/friends",
1195 redirectRootNoLogin: "/main/all",
1196 scopeCopy: true,
1197 sidebarRight: false,
1198 showFeaturesPanel: true,
1199 showInstanceSpecificPanel: false,
1200 subjectLineBehavior: "email",
1201 theme: "pleroma-dark",
1202 webPushNotifications: false
1203 }
1204 ],
1205 children: [
1206 %{
1207 key: :alwaysShowSubjectInput,
1208 label: "Always show subject input",
1209 type: :boolean,
1210 description: "When disabled, auto-hide the subject field if it's empty"
1211 },
1212 %{
1213 key: :background,
1214 type: {:string, :image},
1215 description:
1216 "URL of the background, unless viewing a user profile with a background that is set",
1217 suggestions: ["/images/city.jpg"]
1218 },
1219 %{
1220 key: :collapseMessageWithSubject,
1221 label: "Collapse message with subject",
1222 type: :boolean,
1223 description:
1224 "When a message has a subject (aka Content Warning), collapse it by default"
1225 },
1226 %{
1227 key: :greentext,
1228 label: "Greentext",
1229 type: :boolean,
1230 description: "Enables green text on lines prefixed with the > character"
1231 },
1232 %{
1233 key: :hideFilteredStatuses,
1234 label: "Hide Filtered Statuses",
1235 type: :boolean,
1236 description: "Hides filtered statuses from timelines"
1237 },
1238 %{
1239 key: :hideMutedPosts,
1240 label: "Hide Muted Posts",
1241 type: :boolean,
1242 description: "Hides muted statuses from timelines"
1243 },
1244 %{
1245 key: :hidePostStats,
1246 label: "Hide post stats",
1247 type: :boolean,
1248 description: "Hide notices statistics (repeats, favorites, ...)"
1249 },
1250 %{
1251 key: :hideSitename,
1252 label: "Hide Sitename",
1253 type: :boolean,
1254 description: "Hides instance name from PleromaFE banner"
1255 },
1256 %{
1257 key: :hideUserStats,
1258 label: "Hide user stats",
1259 type: :boolean,
1260 description:
1261 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1262 },
1263 %{
1264 key: :logo,
1265 type: {:string, :image},
1266 description: "URL of the logo, defaults to Pleroma's logo",
1267 suggestions: ["/static/logo.svg"]
1268 },
1269 %{
1270 key: :logoMargin,
1271 label: "Logo margin",
1272 type: :string,
1273 description:
1274 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1275 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1276 suggestions: [".1em"]
1277 },
1278 %{
1279 key: :logoMask,
1280 label: "Logo mask",
1281 type: :boolean,
1282 description:
1283 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1284 "If you want a colorful logo you must disable logoMask."
1285 },
1286 %{
1287 key: :minimalScopesMode,
1288 label: "Minimal scopes mode",
1289 type: :boolean,
1290 description:
1291 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1292 "Also prevents replying to a DM with a public post from PleromaFE."
1293 },
1294 %{
1295 key: :nsfwCensorImage,
1296 label: "NSFW Censor Image",
1297 type: {:string, :image},
1298 description:
1299 "URL of the image to use for hiding NSFW media attachments in the timeline",
1300 suggestions: ["/static/img/nsfw.74818f9.png"]
1301 },
1302 %{
1303 key: :postContentType,
1304 label: "Post Content Type",
1305 type: {:dropdown, :atom},
1306 description: "Default post formatting option",
1307 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1308 },
1309 %{
1310 key: :redirectRootNoLogin,
1311 label: "Redirect root no login",
1312 type: :string,
1313 description:
1314 "Relative URL which indicates where to redirect when a user isn't logged in",
1315 suggestions: ["/main/all"]
1316 },
1317 %{
1318 key: :redirectRootLogin,
1319 label: "Redirect root login",
1320 type: :string,
1321 description:
1322 "Relative URL which indicates where to redirect when a user is logged in",
1323 suggestions: ["/main/friends"]
1324 },
1325 %{
1326 key: :scopeCopy,
1327 label: "Scope copy",
1328 type: :boolean,
1329 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1330 },
1331 %{
1332 key: :sidebarRight,
1333 label: "Sidebar on Right",
1334 type: :boolean,
1335 description: "Change alignment of sidebar and panels to the right"
1336 },
1337 %{
1338 key: :showFeaturesPanel,
1339 label: "Show instance features panel",
1340 type: :boolean,
1341 description:
1342 "Enables panel displaying functionality of the instance on the About page"
1343 },
1344 %{
1345 key: :showInstanceSpecificPanel,
1346 label: "Show instance specific panel",
1347 type: :boolean,
1348 description: "Whether to show the instance's custom panel"
1349 },
1350 %{
1351 key: :subjectLineBehavior,
1352 label: "Subject line behavior",
1353 type: :string,
1354 description: "Allows changing the default behaviour of subject lines in replies.
1355 `email`: copy and preprend re:, as in email,
1356 `masto`: copy verbatim, as in Mastodon,
1357 `noop`: don't copy the subject.",
1358 suggestions: ["email", "masto", "noop"]
1359 },
1360 %{
1361 key: :theme,
1362 type: :string,
1363 description: "Which theme to use. Available themes are defined in styles.json",
1364 suggestions: ["pleroma-dark"]
1365 }
1366 ]
1367 },
1368 %{
1369 key: :masto_fe,
1370 label: "Masto FE",
1371 type: :map,
1372 description: "Settings for Masto FE",
1373 suggestions: [
1374 %{
1375 showInstanceSpecificPanel: true
1376 }
1377 ],
1378 children: [
1379 %{
1380 key: :showInstanceSpecificPanel,
1381 label: "Show instance specific panel",
1382 type: :boolean,
1383 description: "Whenether to show the instance's specific panel"
1384 }
1385 ]
1386 }
1387 ]
1388 },
1389 %{
1390 group: :pleroma,
1391 key: :assets,
1392 type: :group,
1393 description:
1394 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1395 children: [
1396 %{
1397 key: :mascots,
1398 type: {:keyword, :map},
1399 description:
1400 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1401 suggestions: [
1402 pleroma_fox_tan: %{
1403 url: "/images/pleroma-fox-tan-smol.png",
1404 mime_type: "image/png"
1405 },
1406 pleroma_fox_tan_shy: %{
1407 url: "/images/pleroma-fox-tan-shy.png",
1408 mime_type: "image/png"
1409 }
1410 ]
1411 },
1412 %{
1413 key: :default_mascot,
1414 type: :atom,
1415 description:
1416 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1417 suggestions: [
1418 :pleroma_fox_tan
1419 ]
1420 },
1421 %{
1422 key: :default_user_avatar,
1423 type: {:string, :image},
1424 description: "URL of the default user avatar",
1425 suggestions: ["/images/avi.png"]
1426 }
1427 ]
1428 },
1429 %{
1430 group: :pleroma,
1431 key: :manifest,
1432 type: :group,
1433 description:
1434 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1435 children: [
1436 %{
1437 key: :icons,
1438 type: {:list, :map},
1439 description: "Describe the icons of the app",
1440 suggestion: [
1441 %{
1442 src: "/static/logo.png"
1443 },
1444 %{
1445 src: "/static/icon.png",
1446 type: "image/png"
1447 },
1448 %{
1449 src: "/static/icon.ico",
1450 sizes: "72x72 96x96 128x128 256x256"
1451 }
1452 ]
1453 },
1454 %{
1455 key: :theme_color,
1456 type: :string,
1457 description: "Describe the theme color of the app",
1458 suggestions: ["#282c37", "mediumpurple"]
1459 },
1460 %{
1461 key: :background_color,
1462 type: :string,
1463 description: "Describe the background color of the app",
1464 suggestions: ["#191b22", "aliceblue"]
1465 }
1466 ]
1467 },
1468 %{
1469 group: :pleroma,
1470 key: :media_proxy,
1471 type: :group,
1472 description: "Media proxy",
1473 children: [
1474 %{
1475 key: :enabled,
1476 type: :boolean,
1477 description: "Enables proxying of remote media via the instance's proxy"
1478 },
1479 %{
1480 key: :base_url,
1481 label: "Base URL",
1482 type: :string,
1483 description:
1484 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1485 suggestions: ["https://example.com"]
1486 },
1487 %{
1488 key: :invalidation,
1489 type: :keyword,
1490 descpiption: "",
1491 suggestions: [
1492 enabled: true,
1493 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1494 ],
1495 children: [
1496 %{
1497 key: :enabled,
1498 type: :boolean,
1499 description: "Enables media cache object invalidation."
1500 },
1501 %{
1502 key: :provider,
1503 type: :module,
1504 description: "Module which will be used to purge objects from the cache.",
1505 suggestions: [
1506 Pleroma.Web.MediaProxy.Invalidation.Script,
1507 Pleroma.Web.MediaProxy.Invalidation.Http
1508 ]
1509 }
1510 ]
1511 },
1512 %{
1513 key: :proxy_opts,
1514 label: "Advanced MediaProxy Options",
1515 type: :keyword,
1516 description: "Internal Pleroma.ReverseProxy settings",
1517 suggestions: [
1518 redirect_on_failure: false,
1519 max_body_length: 25 * 1_048_576,
1520 max_read_duration: 30_000
1521 ],
1522 children: [
1523 %{
1524 key: :redirect_on_failure,
1525 type: :boolean,
1526 description: """
1527 Redirects the client to the origin server upon encountering HTTP errors.\n
1528 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1529 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1530 IP addresses of your users to the other servers, bypassing the MediaProxy.
1531 """
1532 },
1533 %{
1534 key: :max_body_length,
1535 type: :integer,
1536 description:
1537 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1538 },
1539 %{
1540 key: :max_read_duration,
1541 type: :integer,
1542 description: "Timeout (in milliseconds) of GET request to the remote URI."
1543 }
1544 ]
1545 },
1546 %{
1547 key: :whitelist,
1548 type: {:list, :string},
1549 description: "List of hosts with scheme to bypass the MediaProxy",
1550 suggestions: ["http://example.com"]
1551 }
1552 ]
1553 },
1554 %{
1555 group: :pleroma,
1556 key: :media_preview_proxy,
1557 type: :group,
1558 description: "Media preview proxy",
1559 children: [
1560 %{
1561 key: :enabled,
1562 type: :boolean,
1563 description:
1564 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1565 },
1566 %{
1567 key: :thumbnail_max_width,
1568 type: :integer,
1569 description:
1570 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1571 },
1572 %{
1573 key: :thumbnail_max_height,
1574 type: :integer,
1575 description:
1576 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1577 },
1578 %{
1579 key: :image_quality,
1580 type: :integer,
1581 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1582 },
1583 %{
1584 key: :min_content_length,
1585 type: :integer,
1586 description:
1587 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1588 }
1589 ]
1590 },
1591 %{
1592 group: :pleroma,
1593 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1594 type: :group,
1595 description: "HTTP invalidate settings",
1596 children: [
1597 %{
1598 key: :method,
1599 type: :atom,
1600 description: "HTTP method of request. Default: :purge"
1601 },
1602 %{
1603 key: :headers,
1604 type: {:keyword, :string},
1605 description: "HTTP headers of request",
1606 suggestions: [{"x-refresh", 1}]
1607 },
1608 %{
1609 key: :options,
1610 type: :keyword,
1611 description: "Request options",
1612 children: [
1613 %{
1614 key: :params,
1615 type: {:map, :string}
1616 }
1617 ]
1618 }
1619 ]
1620 },
1621 %{
1622 group: :pleroma,
1623 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1624 type: :group,
1625 description: "Invalidation script settings",
1626 children: [
1627 %{
1628 key: :script_path,
1629 type: :string,
1630 description: "Path to executable script which will purge cached items.",
1631 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1632 },
1633 %{
1634 key: :url_format,
1635 label: "URL Format",
1636 type: :string,
1637 description:
1638 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1639 suggestions: [":htcacheclean"]
1640 }
1641 ]
1642 },
1643 %{
1644 group: :pleroma,
1645 key: :gopher,
1646 type: :group,
1647 description: "Gopher settings",
1648 children: [
1649 %{
1650 key: :enabled,
1651 type: :boolean,
1652 description: "Enables the gopher interface"
1653 },
1654 %{
1655 key: :ip,
1656 label: "IP",
1657 type: :tuple,
1658 description: "IP address to bind to",
1659 suggestions: [{0, 0, 0, 0}]
1660 },
1661 %{
1662 key: :port,
1663 type: :integer,
1664 description: "Port to bind to",
1665 suggestions: [9999]
1666 },
1667 %{
1668 key: :dstport,
1669 type: :integer,
1670 description: "Port advertised in URLs (optional, defaults to port)",
1671 suggestions: [9999]
1672 }
1673 ]
1674 },
1675 %{
1676 group: :pleroma,
1677 key: :activitypub,
1678 label: "ActivityPub",
1679 type: :group,
1680 description: "ActivityPub-related settings",
1681 children: [
1682 %{
1683 key: :unfollow_blocked,
1684 type: :boolean,
1685 description: "Whether blocks result in people getting unfollowed"
1686 },
1687 %{
1688 key: :outgoing_blocks,
1689 type: :boolean,
1690 description: "Whether to federate blocks to other instances"
1691 },
1692 %{
1693 key: :sign_object_fetches,
1694 type: :boolean,
1695 description: "Sign object fetches with HTTP signatures"
1696 },
1697 %{
1698 key: :note_replies_output_limit,
1699 type: :integer,
1700 description:
1701 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1702 },
1703 %{
1704 key: :follow_handshake_timeout,
1705 type: :integer,
1706 description: "Following handshake timeout",
1707 suggestions: [500]
1708 }
1709 ]
1710 },
1711 %{
1712 group: :pleroma,
1713 key: :http_security,
1714 label: "HTTP security",
1715 type: :group,
1716 description: "HTTP security settings",
1717 children: [
1718 %{
1719 key: :enabled,
1720 type: :boolean,
1721 description: "Whether the managed content security policy is enabled"
1722 },
1723 %{
1724 key: :sts,
1725 label: "STS",
1726 type: :boolean,
1727 description: "Whether to additionally send a Strict-Transport-Security header"
1728 },
1729 %{
1730 key: :sts_max_age,
1731 label: "STS max age",
1732 type: :integer,
1733 description: "The maximum age for the Strict-Transport-Security header if sent",
1734 suggestions: [31_536_000]
1735 },
1736 %{
1737 key: :ct_max_age,
1738 label: "CT max age",
1739 type: :integer,
1740 description: "The maximum age for the Expect-CT header if sent",
1741 suggestions: [2_592_000]
1742 },
1743 %{
1744 key: :referrer_policy,
1745 type: :string,
1746 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1747 suggestions: ["same-origin", "no-referrer"]
1748 },
1749 %{
1750 key: :report_uri,
1751 label: "Report URI",
1752 type: :string,
1753 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1754 suggestions: ["https://example.com/report-uri"]
1755 }
1756 ]
1757 },
1758 %{
1759 group: :web_push_encryption,
1760 key: :vapid_details,
1761 label: "Vapid Details",
1762 type: :group,
1763 description:
1764 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1765 children: [
1766 %{
1767 key: :subject,
1768 type: :string,
1769 description:
1770 "A mailto link for the administrative contact." <>
1771 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1772 suggestions: ["mailto:moderators@pleroma.com"]
1773 },
1774 %{
1775 key: :public_key,
1776 type: :string,
1777 description: "VAPID public key",
1778 suggestions: ["Public key"]
1779 },
1780 %{
1781 key: :private_key,
1782 type: :string,
1783 description: "VAPID private key",
1784 suggestions: ["Private key"]
1785 }
1786 ]
1787 },
1788 %{
1789 group: :pleroma,
1790 key: Pleroma.Captcha,
1791 type: :group,
1792 description: "Captcha-related settings",
1793 children: [
1794 %{
1795 key: :enabled,
1796 type: :boolean,
1797 description: "Whether the captcha should be shown on registration"
1798 },
1799 %{
1800 key: :method,
1801 type: :module,
1802 description: "The method/service to use for captcha",
1803 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1804 },
1805 %{
1806 key: :seconds_valid,
1807 type: :integer,
1808 description: "The time in seconds for which the captcha is valid",
1809 suggestions: [60]
1810 }
1811 ]
1812 },
1813 %{
1814 group: :pleroma,
1815 key: Pleroma.Captcha.Kocaptcha,
1816 type: :group,
1817 description:
1818 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1819 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1820 children: [
1821 %{
1822 key: :endpoint,
1823 type: :string,
1824 description: "The kocaptcha endpoint to use",
1825 suggestions: ["https://captcha.kotobank.ch"]
1826 }
1827 ]
1828 },
1829 %{
1830 group: :pleroma,
1831 label: "Pleroma Admin Token",
1832 type: :group,
1833 description:
1834 "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)",
1835 children: [
1836 %{
1837 key: :admin_token,
1838 type: :string,
1839 description: "Admin token",
1840 suggestions: [
1841 "Please use a high entropy string or UUID"
1842 ]
1843 }
1844 ]
1845 },
1846 %{
1847 group: :pleroma,
1848 key: Oban,
1849 type: :group,
1850 description:
1851 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1852 children: [
1853 %{
1854 key: :log,
1855 type: {:dropdown, :atom},
1856 description: "Logs verbose mode",
1857 suggestions: [false, :error, :warn, :info, :debug]
1858 },
1859 %{
1860 key: :queues,
1861 type: {:keyword, :integer},
1862 description:
1863 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1864 suggestions: [
1865 activity_expiration: 10,
1866 attachments_cleanup: 5,
1867 background: 5,
1868 federator_incoming: 50,
1869 federator_outgoing: 50,
1870 mailer: 10,
1871 scheduled_activities: 10,
1872 transmogrifier: 20,
1873 web_push: 50
1874 ],
1875 children: [
1876 %{
1877 key: :activity_expiration,
1878 type: :integer,
1879 description: "Activity expiration queue",
1880 suggestions: [10]
1881 },
1882 %{
1883 key: :backup,
1884 type: :integer,
1885 description: "Backup queue",
1886 suggestions: [1]
1887 },
1888 %{
1889 key: :attachments_cleanup,
1890 type: :integer,
1891 description: "Attachment deletion queue",
1892 suggestions: [5]
1893 },
1894 %{
1895 key: :background,
1896 type: :integer,
1897 description: "Background queue",
1898 suggestions: [5]
1899 },
1900 %{
1901 key: :federator_incoming,
1902 type: :integer,
1903 description: "Incoming federation queue",
1904 suggestions: [50]
1905 },
1906 %{
1907 key: :federator_outgoing,
1908 type: :integer,
1909 description: "Outgoing federation queue",
1910 suggestions: [50]
1911 },
1912 %{
1913 key: :mailer,
1914 type: :integer,
1915 description: "Email sender queue, see Pleroma.Emails.Mailer",
1916 suggestions: [10]
1917 },
1918 %{
1919 key: :scheduled_activities,
1920 type: :integer,
1921 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1922 suggestions: [10]
1923 },
1924 %{
1925 key: :transmogrifier,
1926 type: :integer,
1927 description: "Transmogrifier queue",
1928 suggestions: [20]
1929 },
1930 %{
1931 key: :web_push,
1932 type: :integer,
1933 description: "Web push notifications queue",
1934 suggestions: [50]
1935 }
1936 ]
1937 },
1938 %{
1939 key: :crontab,
1940 type: {:list, :tuple},
1941 description: "Settings for cron background jobs",
1942 suggestions: [
1943 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1944 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1945 ]
1946 }
1947 ]
1948 },
1949 %{
1950 group: :pleroma,
1951 key: :workers,
1952 type: :group,
1953 description: "Includes custom worker options not interpretable directly by `Oban`",
1954 children: [
1955 %{
1956 key: :retries,
1957 type: {:keyword, :integer},
1958 description: "Max retry attempts for failed jobs, per `Oban` queue",
1959 suggestions: [
1960 federator_incoming: 5,
1961 federator_outgoing: 5
1962 ]
1963 }
1964 ]
1965 },
1966 %{
1967 group: :pleroma,
1968 key: Pleroma.Web.Metadata,
1969 type: :group,
1970 description: "Metadata-related settings",
1971 children: [
1972 %{
1973 key: :providers,
1974 type: {:list, :module},
1975 description: "List of metadata providers to enable",
1976 suggestions: [
1977 Pleroma.Web.Metadata.Providers.OpenGraph,
1978 Pleroma.Web.Metadata.Providers.TwitterCard,
1979 Pleroma.Web.Metadata.Providers.RelMe,
1980 Pleroma.Web.Metadata.Providers.Feed
1981 ]
1982 },
1983 %{
1984 key: :unfurl_nsfw,
1985 label: "Unfurl NSFW",
1986 type: :boolean,
1987 description: "When enabled NSFW attachments will be shown in previews"
1988 }
1989 ]
1990 },
1991 %{
1992 group: :pleroma,
1993 key: :rich_media,
1994 type: :group,
1995 description:
1996 "If enabled the instance will parse metadata from attached links to generate link previews",
1997 children: [
1998 %{
1999 key: :enabled,
2000 type: :boolean,
2001 description: "Enables RichMedia parsing of URLs"
2002 },
2003 %{
2004 key: :ignore_hosts,
2005 type: {:list, :string},
2006 description: "List of hosts which will be ignored by the metadata parser",
2007 suggestions: ["accounts.google.com", "xss.website"]
2008 },
2009 %{
2010 key: :ignore_tld,
2011 label: "Ignore TLD",
2012 type: {:list, :string},
2013 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2014 suggestions: ["local", "localdomain", "lan"]
2015 },
2016 %{
2017 key: :parsers,
2018 type: {:list, :module},
2019 description:
2020 "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.",
2021 suggestions: [
2022 Pleroma.Web.RichMedia.Parsers.OEmbed,
2023 Pleroma.Web.RichMedia.Parsers.TwitterCard
2024 ]
2025 },
2026 %{
2027 key: :ttl_setters,
2028 label: "TTL setters",
2029 type: {:list, :module},
2030 description:
2031 "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.",
2032 suggestions: [
2033 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2034 ]
2035 },
2036 %{
2037 key: :failure_backoff,
2038 type: :integer,
2039 description:
2040 "Amount of milliseconds after request failure, during which the request will not be retried.",
2041 suggestions: [60_000]
2042 }
2043 ]
2044 },
2045 %{
2046 group: :pleroma,
2047 key: Pleroma.Formatter,
2048 label: "Linkify",
2049 type: :group,
2050 description:
2051 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2052 children: [
2053 %{
2054 key: :class,
2055 type: [:string, :boolean],
2056 description: "Specify the class to be added to the generated link. Disable to clear.",
2057 suggestions: ["auto-linker", false]
2058 },
2059 %{
2060 key: :rel,
2061 type: [:string, :boolean],
2062 description: "Override the rel attribute. Disable to clear.",
2063 suggestions: ["ugc", "noopener noreferrer", false]
2064 },
2065 %{
2066 key: :new_window,
2067 type: :boolean,
2068 description: "Link URLs will open in a new window/tab."
2069 },
2070 %{
2071 key: :truncate,
2072 type: [:integer, :boolean],
2073 description:
2074 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2075 suggestions: [15, false]
2076 },
2077 %{
2078 key: :strip_prefix,
2079 type: :boolean,
2080 description: "Strip the scheme prefix."
2081 },
2082 %{
2083 key: :extra,
2084 type: :boolean,
2085 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2086 },
2087 %{
2088 key: :validate_tld,
2089 type: [:atom, :boolean],
2090 description:
2091 "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)",
2092 suggestions: [:no_scheme, true]
2093 }
2094 ]
2095 },
2096 %{
2097 group: :pleroma,
2098 key: Pleroma.ScheduledActivity,
2099 type: :group,
2100 description: "Scheduled activities settings",
2101 children: [
2102 %{
2103 key: :daily_user_limit,
2104 type: :integer,
2105 description:
2106 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2107 suggestions: [25]
2108 },
2109 %{
2110 key: :total_user_limit,
2111 type: :integer,
2112 description:
2113 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2114 suggestions: [300]
2115 },
2116 %{
2117 key: :enabled,
2118 type: :boolean,
2119 description: "Whether scheduled activities are sent to the job queue to be executed"
2120 }
2121 ]
2122 },
2123 %{
2124 group: :pleroma,
2125 key: Pleroma.Workers.PurgeExpiredActivity,
2126 type: :group,
2127 description: "Expired activities settings",
2128 children: [
2129 %{
2130 key: :enabled,
2131 type: :boolean,
2132 description: "Enables expired activities addition & deletion"
2133 },
2134 %{
2135 key: :min_lifetime,
2136 type: :integer,
2137 description: "Minimum lifetime for ephemeral activity (in seconds)",
2138 suggestions: [600]
2139 }
2140 ]
2141 },
2142 %{
2143 group: :pleroma,
2144 label: "Pleroma Authenticator",
2145 type: :group,
2146 description: "Authenticator",
2147 children: [
2148 %{
2149 key: Pleroma.Web.Auth.Authenticator,
2150 type: :module,
2151 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2152 }
2153 ]
2154 },
2155 %{
2156 group: :pleroma,
2157 key: :ldap,
2158 label: "LDAP",
2159 type: :group,
2160 description:
2161 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2162 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2163 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2164 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2165 children: [
2166 %{
2167 key: :enabled,
2168 type: :boolean,
2169 description: "Enables LDAP authentication"
2170 },
2171 %{
2172 key: :host,
2173 type: :string,
2174 description: "LDAP server hostname",
2175 suggestions: ["localhosts"]
2176 },
2177 %{
2178 key: :port,
2179 type: :integer,
2180 description: "LDAP port, e.g. 389 or 636",
2181 suggestions: [389, 636]
2182 },
2183 %{
2184 key: :ssl,
2185 label: "SSL",
2186 type: :boolean,
2187 description: "Enable to use SSL, usually implies the port 636"
2188 },
2189 %{
2190 key: :sslopts,
2191 label: "SSL options",
2192 type: :keyword,
2193 description: "Additional SSL options",
2194 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2195 children: [
2196 %{
2197 key: :cacertfile,
2198 type: :string,
2199 description: "Path to file with PEM encoded cacerts",
2200 suggestions: ["path/to/file/with/PEM/cacerts"]
2201 },
2202 %{
2203 key: :verify,
2204 type: :atom,
2205 description: "Type of cert verification",
2206 suggestions: [:verify_peer]
2207 }
2208 ]
2209 },
2210 %{
2211 key: :tls,
2212 label: "TLS",
2213 type: :boolean,
2214 description: "Enable to use STARTTLS, usually implies the port 389"
2215 },
2216 %{
2217 key: :tlsopts,
2218 label: "TLS options",
2219 type: :keyword,
2220 description: "Additional TLS options",
2221 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2222 children: [
2223 %{
2224 key: :cacertfile,
2225 type: :string,
2226 description: "Path to file with PEM encoded cacerts",
2227 suggestions: ["path/to/file/with/PEM/cacerts"]
2228 },
2229 %{
2230 key: :verify,
2231 type: :atom,
2232 description: "Type of cert verification",
2233 suggestions: [:verify_peer]
2234 }
2235 ]
2236 },
2237 %{
2238 key: :base,
2239 type: :string,
2240 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2241 suggestions: ["dc=example,dc=com"]
2242 },
2243 %{
2244 key: :uid,
2245 label: "UID",
2246 type: :string,
2247 description:
2248 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2249 suggestions: ["cn"]
2250 }
2251 ]
2252 },
2253 %{
2254 group: :pleroma,
2255 key: :auth,
2256 type: :group,
2257 description: "Authentication / authorization settings",
2258 children: [
2259 %{
2260 key: :enforce_oauth_admin_scope_usage,
2261 label: "Enforce OAuth admin scope usage",
2262 type: :boolean,
2263 description:
2264 "OAuth admin scope requirement toggle. " <>
2265 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2266 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2267 "`is_admin` user flag grants access to admin-specific actions."
2268 },
2269 %{
2270 key: :auth_template,
2271 type: :string,
2272 description:
2273 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2274 suggestions: ["show.html"]
2275 },
2276 %{
2277 key: :oauth_consumer_template,
2278 label: "OAuth consumer template",
2279 type: :string,
2280 description:
2281 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2282 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2283 suggestions: ["consumer.html"]
2284 },
2285 %{
2286 key: :oauth_consumer_strategies,
2287 label: "OAuth consumer strategies",
2288 type: {:list, :string},
2289 description:
2290 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2291 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2292 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2293 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2294 }
2295 ]
2296 },
2297 %{
2298 group: :pleroma,
2299 key: :email_notifications,
2300 type: :group,
2301 description: "Email notifications settings",
2302 children: [
2303 %{
2304 key: :digest,
2305 type: :map,
2306 description:
2307 "emails of \"what you've missed\" for users who have been inactive for a while",
2308 suggestions: [
2309 %{
2310 active: false,
2311 schedule: "0 0 * * 0",
2312 interval: 7,
2313 inactivity_threshold: 7
2314 }
2315 ],
2316 children: [
2317 %{
2318 key: :active,
2319 label: "Enabled",
2320 type: :boolean,
2321 description: "Globally enable or disable digest emails"
2322 },
2323 %{
2324 key: :schedule,
2325 type: :string,
2326 description:
2327 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2328 suggestions: ["0 0 * * 0"]
2329 },
2330 %{
2331 key: :interval,
2332 type: :integer,
2333 description: "Minimum interval between digest emails to one user",
2334 suggestions: [7]
2335 },
2336 %{
2337 key: :inactivity_threshold,
2338 type: :integer,
2339 description: "Minimum user inactivity threshold",
2340 suggestions: [7]
2341 }
2342 ]
2343 }
2344 ]
2345 },
2346 %{
2347 group: :pleroma,
2348 key: Pleroma.Emails.UserEmail,
2349 type: :group,
2350 description: "Email template settings",
2351 children: [
2352 %{
2353 key: :logo,
2354 type: {:string, :image},
2355 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2356 suggestions: ["some/path/logo.png"]
2357 },
2358 %{
2359 key: :styling,
2360 type: :map,
2361 description: "A map with color settings for email templates.",
2362 suggestions: [
2363 %{
2364 link_color: "#d8a070",
2365 background_color: "#2C3645",
2366 content_background_color: "#1B2635",
2367 header_color: "#d8a070",
2368 text_color: "#b9b9ba",
2369 text_muted_color: "#b9b9ba"
2370 }
2371 ],
2372 children: [
2373 %{
2374 key: :link_color,
2375 type: :string,
2376 suggestions: ["#d8a070"]
2377 },
2378 %{
2379 key: :background_color,
2380 type: :string,
2381 suggestions: ["#2C3645"]
2382 },
2383 %{
2384 key: :content_background_color,
2385 type: :string,
2386 suggestions: ["#1B2635"]
2387 },
2388 %{
2389 key: :header_color,
2390 type: :string,
2391 suggestions: ["#d8a070"]
2392 },
2393 %{
2394 key: :text_color,
2395 type: :string,
2396 suggestions: ["#b9b9ba"]
2397 },
2398 %{
2399 key: :text_muted_color,
2400 type: :string,
2401 suggestions: ["#b9b9ba"]
2402 }
2403 ]
2404 }
2405 ]
2406 },
2407 %{
2408 group: :pleroma,
2409 key: Pleroma.Emails.NewUsersDigestEmail,
2410 type: :group,
2411 description: "New users admin email digest",
2412 children: [
2413 %{
2414 key: :enabled,
2415 type: :boolean,
2416 description: "Enables new users admin digest email when `true`"
2417 }
2418 ]
2419 },
2420 %{
2421 group: :pleroma,
2422 key: :oauth2,
2423 label: "OAuth2",
2424 type: :group,
2425 description: "Configure OAuth 2 provider capabilities",
2426 children: [
2427 %{
2428 key: :token_expires_in,
2429 type: :integer,
2430 description: "The lifetime in seconds of the access token",
2431 suggestions: [2_592_000]
2432 },
2433 %{
2434 key: :issue_new_refresh_token,
2435 type: :boolean,
2436 description:
2437 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2438 },
2439 %{
2440 key: :clean_expired_tokens,
2441 type: :boolean,
2442 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2443 }
2444 ]
2445 },
2446 %{
2447 group: :pleroma,
2448 key: :emoji,
2449 type: :group,
2450 children: [
2451 %{
2452 key: :shortcode_globs,
2453 type: {:list, :string},
2454 description: "Location of custom emoji files. * can be used as a wildcard.",
2455 suggestions: ["/emoji/custom/**/*.png"]
2456 },
2457 %{
2458 key: :pack_extensions,
2459 type: {:list, :string},
2460 description:
2461 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2462 suggestions: [".png", ".gif"]
2463 },
2464 %{
2465 key: :groups,
2466 type: {:keyword, {:list, :string}},
2467 description:
2468 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2469 " and the value is the location or array of locations. * can be used as a wildcard.",
2470 suggestions: [
2471 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2472 ]
2473 },
2474 %{
2475 key: :default_manifest,
2476 type: :string,
2477 description:
2478 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2479 " Currently only one manifest can be added (no arrays).",
2480 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2481 },
2482 %{
2483 key: :shared_pack_cache_seconds_per_file,
2484 label: "Shared pack cache s/file",
2485 type: :integer,
2486 descpiption:
2487 "When an emoji pack is shared, the archive is created and cached in memory" <>
2488 " for this amount of seconds multiplied by the number of files.",
2489 suggestions: [60]
2490 }
2491 ]
2492 },
2493 %{
2494 group: :pleroma,
2495 key: :rate_limit,
2496 type: :group,
2497 description:
2498 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2499 children: [
2500 %{
2501 key: :search,
2502 type: [:tuple, {:list, :tuple}],
2503 description: "For the search requests (account & status search etc.)",
2504 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2505 },
2506 %{
2507 key: :timeline,
2508 type: [:tuple, {:list, :tuple}],
2509 description: "For requests to timelines (each timeline has it's own limiter)",
2510 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2511 },
2512 %{
2513 key: :app_account_creation,
2514 type: [:tuple, {:list, :tuple}],
2515 description: "For registering user accounts from the same IP address",
2516 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2517 },
2518 %{
2519 key: :relations_actions,
2520 type: [:tuple, {:list, :tuple}],
2521 description: "For actions on relationships with all users (follow, unfollow)",
2522 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2523 },
2524 %{
2525 key: :relation_id_action,
2526 label: "Relation ID action",
2527 type: [:tuple, {:list, :tuple}],
2528 description: "For actions on relation with a specific user (follow, unfollow)",
2529 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2530 },
2531 %{
2532 key: :statuses_actions,
2533 type: [:tuple, {:list, :tuple}],
2534 description:
2535 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2536 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2537 },
2538 %{
2539 key: :status_id_action,
2540 label: "Status ID action",
2541 type: [:tuple, {:list, :tuple}],
2542 description:
2543 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2544 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2545 },
2546 %{
2547 key: :authentication,
2548 type: [:tuple, {:list, :tuple}],
2549 description: "For authentication create / password check / user existence check requests",
2550 suggestions: [{60_000, 15}]
2551 }
2552 ]
2553 },
2554 %{
2555 group: :esshd,
2556 label: "ESSHD",
2557 type: :group,
2558 description:
2559 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2560 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2561 children: [
2562 %{
2563 key: :enabled,
2564 type: :boolean,
2565 description: "Enables SSH"
2566 },
2567 %{
2568 key: :priv_dir,
2569 type: :string,
2570 description: "Dir with SSH keys",
2571 suggestions: ["/some/path/ssh_keys"]
2572 },
2573 %{
2574 key: :handler,
2575 type: :string,
2576 description: "Handler module",
2577 suggestions: ["Pleroma.BBS.Handler"]
2578 },
2579 %{
2580 key: :port,
2581 type: :integer,
2582 description: "Port to connect",
2583 suggestions: [10_022]
2584 },
2585 %{
2586 key: :password_authenticator,
2587 type: :string,
2588 description: "Authenticator module",
2589 suggestions: ["Pleroma.BBS.Authenticator"]
2590 }
2591 ]
2592 },
2593 %{
2594 group: :mime,
2595 label: "Mime Types",
2596 type: :group,
2597 description: "Mime Types settings",
2598 children: [
2599 %{
2600 key: :types,
2601 type: :map,
2602 suggestions: [
2603 %{
2604 "application/xml" => ["xml"],
2605 "application/xrd+xml" => ["xrd+xml"],
2606 "application/jrd+json" => ["jrd+json"],
2607 "application/activity+json" => ["activity+json"],
2608 "application/ld+json" => ["activity+json"]
2609 }
2610 ],
2611 children: [
2612 %{
2613 key: "application/xml",
2614 type: {:list, :string},
2615 suggestions: ["xml"]
2616 },
2617 %{
2618 key: "application/xrd+xml",
2619 type: {:list, :string},
2620 suggestions: ["xrd+xml"]
2621 },
2622 %{
2623 key: "application/jrd+json",
2624 type: {:list, :string},
2625 suggestions: ["jrd+json"]
2626 },
2627 %{
2628 key: "application/activity+json",
2629 type: {:list, :string},
2630 suggestions: ["activity+json"]
2631 },
2632 %{
2633 key: "application/ld+json",
2634 type: {:list, :string},
2635 suggestions: ["activity+json"]
2636 }
2637 ]
2638 }
2639 ]
2640 },
2641 %{
2642 group: :pleroma,
2643 key: :shout,
2644 type: :group,
2645 description: "Pleroma shout settings",
2646 children: [
2647 %{
2648 key: :enabled,
2649 type: :boolean,
2650 description: "Enables the backend Shoutbox chat feature."
2651 },
2652 %{
2653 key: :limit,
2654 type: :integer,
2655 description: "Shout message character limit.",
2656 suggestions: [
2657 5_000
2658 ]
2659 }
2660 ]
2661 },
2662 %{
2663 group: :pleroma,
2664 key: :http,
2665 label: "HTTP",
2666 type: :group,
2667 description: "HTTP settings",
2668 children: [
2669 %{
2670 key: :proxy_url,
2671 label: "Proxy URL",
2672 type: [:string, :tuple],
2673 description: "Proxy URL",
2674 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2675 },
2676 %{
2677 key: :send_user_agent,
2678 type: :boolean
2679 },
2680 %{
2681 key: :user_agent,
2682 type: [:string, :atom],
2683 description:
2684 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2685 suggestions: ["Pleroma", :default]
2686 },
2687 %{
2688 key: :adapter,
2689 type: :keyword,
2690 description: "Adapter specific options",
2691 suggestions: [],
2692 children: [
2693 %{
2694 key: :ssl_options,
2695 type: :keyword,
2696 label: "SSL Options",
2697 description: "SSL options for HTTP adapter",
2698 children: [
2699 %{
2700 key: :versions,
2701 type: {:list, :atom},
2702 description: "List of TLS version to use",
2703 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2704 }
2705 ]
2706 }
2707 ]
2708 }
2709 ]
2710 },
2711 %{
2712 group: :pleroma,
2713 key: :markup,
2714 label: "Markup Settings",
2715 type: :group,
2716 children: [
2717 %{
2718 key: :allow_inline_images,
2719 type: :boolean
2720 },
2721 %{
2722 key: :allow_headings,
2723 type: :boolean
2724 },
2725 %{
2726 key: :allow_tables,
2727 type: :boolean
2728 },
2729 %{
2730 key: :allow_fonts,
2731 type: :boolean
2732 },
2733 %{
2734 key: :scrub_policy,
2735 type: {:list, :module},
2736 description:
2737 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2738 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2739 }
2740 ]
2741 },
2742 %{
2743 group: :pleroma,
2744 key: :user,
2745 type: :group,
2746 children: [
2747 %{
2748 key: :deny_follow_blocked,
2749 type: :boolean
2750 }
2751 ]
2752 },
2753 %{
2754 group: :pleroma,
2755 key: Pleroma.User,
2756 type: :group,
2757 children: [
2758 %{
2759 key: :restricted_nicknames,
2760 type: {:list, :string},
2761 description: "List of nicknames users may not register with.",
2762 suggestions: [
2763 ".well-known",
2764 "~",
2765 "about",
2766 "activities",
2767 "api",
2768 "auth",
2769 "check_password",
2770 "dev",
2771 "friend-requests",
2772 "inbox",
2773 "internal",
2774 "main",
2775 "media",
2776 "nodeinfo",
2777 "notice",
2778 "oauth",
2779 "objects",
2780 "ostatus_subscribe",
2781 "pleroma",
2782 "proxy",
2783 "push",
2784 "registration",
2785 "relay",
2786 "settings",
2787 "status",
2788 "tag",
2789 "user-search",
2790 "user_exists",
2791 "users",
2792 "web"
2793 ]
2794 },
2795 %{
2796 key: :email_blacklist,
2797 type: {:list, :string},
2798 description: "List of email domains users may not register with.",
2799 suggestions: ["mailinator.com", "maildrop.cc"]
2800 }
2801 ]
2802 },
2803 %{
2804 group: :cors_plug,
2805 label: "CORS plug config",
2806 type: :group,
2807 children: [
2808 %{
2809 key: :max_age,
2810 type: :integer,
2811 suggestions: [86_400]
2812 },
2813 %{
2814 key: :methods,
2815 type: {:list, :string},
2816 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2817 },
2818 %{
2819 key: :expose,
2820 type: {:list, :string},
2821 suggestions: [
2822 "Link",
2823 "X-RateLimit-Reset",
2824 "X-RateLimit-Limit",
2825 "X-RateLimit-Remaining",
2826 "X-Request-Id",
2827 "Idempotency-Key"
2828 ]
2829 },
2830 %{
2831 key: :credentials,
2832 type: :boolean
2833 },
2834 %{
2835 key: :headers,
2836 type: {:list, :string},
2837 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2838 }
2839 ]
2840 },
2841 %{
2842 group: :pleroma,
2843 key: Pleroma.Web.Plugs.RemoteIp,
2844 type: :group,
2845 description: """
2846 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2847 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2848 """,
2849 children: [
2850 %{
2851 key: :enabled,
2852 type: :boolean,
2853 description: "Enable/disable the plug. Default: disabled."
2854 },
2855 %{
2856 key: :headers,
2857 type: {:list, :string},
2858 description: """
2859 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2860 """
2861 },
2862 %{
2863 key: :proxies,
2864 type: {:list, :string},
2865 description:
2866 "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."
2867 },
2868 %{
2869 key: :reserved,
2870 type: {:list, :string},
2871 description: """
2872 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"]`
2873 """
2874 }
2875 ]
2876 },
2877 %{
2878 group: :pleroma,
2879 key: :web_cache_ttl,
2880 label: "Web cache TTL",
2881 type: :group,
2882 description:
2883 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2884 children: [
2885 %{
2886 key: :activity_pub,
2887 type: :integer,
2888 description:
2889 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2890 suggestions: [nil]
2891 },
2892 %{
2893 key: :activity_pub_question,
2894 type: :integer,
2895 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2896 suggestions: [30_000]
2897 }
2898 ]
2899 },
2900 %{
2901 group: :pleroma,
2902 key: :static_fe,
2903 label: "Static FE",
2904 type: :group,
2905 description:
2906 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2907 children: [
2908 %{
2909 key: :enabled,
2910 type: :boolean,
2911 description: "Enables the rendering of static HTML. Default: disabled."
2912 }
2913 ]
2914 },
2915 %{
2916 group: :pleroma,
2917 key: :feed,
2918 type: :group,
2919 description: "Configure feed rendering",
2920 children: [
2921 %{
2922 key: :post_title,
2923 type: :map,
2924 description: "Configure title rendering",
2925 children: [
2926 %{
2927 key: :max_length,
2928 type: :integer,
2929 description: "Maximum number of characters before truncating title",
2930 suggestions: [100]
2931 },
2932 %{
2933 key: :omission,
2934 type: :string,
2935 description: "Replacement which will be used after truncating string",
2936 suggestions: ["..."]
2937 }
2938 ]
2939 }
2940 ]
2941 },
2942 %{
2943 group: :pleroma,
2944 key: :mrf_follow_bot,
2945 tab: :mrf,
2946 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2947 label: "MRF FollowBot Policy",
2948 type: :group,
2949 description: "Automatically follows newly discovered accounts.",
2950 children: [
2951 %{
2952 key: :follower_nickname,
2953 type: :string,
2954 description: "The name of the bot account to use for following newly discovered users.",
2955 suggestions: ["followbot"]
2956 }
2957 ]
2958 },
2959 %{
2960 group: :pleroma,
2961 key: :modules,
2962 type: :group,
2963 description: "Custom Runtime Modules",
2964 children: [
2965 %{
2966 key: :runtime_dir,
2967 type: :string,
2968 description: "A path to custom Elixir modules (such as MRF policies)."
2969 }
2970 ]
2971 },
2972 %{
2973 group: :pleroma,
2974 key: :streamer,
2975 type: :group,
2976 description: "Settings for notifications streamer",
2977 children: [
2978 %{
2979 key: :workers,
2980 type: :integer,
2981 description: "Number of workers to send notifications",
2982 suggestions: [3]
2983 },
2984 %{
2985 key: :overflow_workers,
2986 type: :integer,
2987 description: "Maximum number of workers created if pool is empty",
2988 suggestions: [2]
2989 }
2990 ]
2991 },
2992 %{
2993 group: :pleroma,
2994 key: :connections_pool,
2995 type: :group,
2996 description: "Advanced settings for `Gun` connections pool",
2997 children: [
2998 %{
2999 key: :connection_acquisition_wait,
3000 type: :integer,
3001 description:
3002 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3003 suggestions: [250]
3004 },
3005 %{
3006 key: :connection_acquisition_retries,
3007 type: :integer,
3008 description:
3009 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3010 suggestions: [5]
3011 },
3012 %{
3013 key: :max_connections,
3014 type: :integer,
3015 description: "Maximum number of connections in the pool. Default: 250 connections.",
3016 suggestions: [250]
3017 },
3018 %{
3019 key: :connect_timeout,
3020 type: :integer,
3021 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3022 suggestions: [5000]
3023 },
3024 %{
3025 key: :reclaim_multiplier,
3026 type: :integer,
3027 description:
3028 "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",
3029 suggestions: [0.1]
3030 }
3031 ]
3032 },
3033 %{
3034 group: :pleroma,
3035 key: :pools,
3036 type: :group,
3037 description: "Advanced settings for `Gun` workers pools",
3038 children:
3039 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3040 %{
3041 key: pool_name,
3042 type: :keyword,
3043 description: "Settings for #{pool_name} pool.",
3044 children: [
3045 %{
3046 key: :size,
3047 type: :integer,
3048 description: "Maximum number of concurrent requests in the pool.",
3049 suggestions: [50]
3050 },
3051 %{
3052 key: :max_waiting,
3053 type: :integer,
3054 description:
3055 "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",
3056 suggestions: [10]
3057 },
3058 %{
3059 key: :recv_timeout,
3060 type: :integer,
3061 description: "Timeout for the pool while gun will wait for response",
3062 suggestions: [10_000]
3063 }
3064 ]
3065 }
3066 end)
3067 },
3068 %{
3069 group: :pleroma,
3070 key: :hackney_pools,
3071 type: :group,
3072 description: "Advanced settings for `Hackney` connections pools",
3073 children: [
3074 %{
3075 key: :federation,
3076 type: :keyword,
3077 description: "Settings for federation pool.",
3078 children: [
3079 %{
3080 key: :max_connections,
3081 type: :integer,
3082 description: "Number workers in the pool.",
3083 suggestions: [50]
3084 },
3085 %{
3086 key: :timeout,
3087 type: :integer,
3088 description: "Timeout while `hackney` will wait for response.",
3089 suggestions: [150_000]
3090 }
3091 ]
3092 },
3093 %{
3094 key: :media,
3095 type: :keyword,
3096 description: "Settings for media pool.",
3097 children: [
3098 %{
3099 key: :max_connections,
3100 type: :integer,
3101 description: "Number workers in the pool.",
3102 suggestions: [50]
3103 },
3104 %{
3105 key: :timeout,
3106 type: :integer,
3107 description: "Timeout while `hackney` will wait for response.",
3108 suggestions: [150_000]
3109 }
3110 ]
3111 },
3112 %{
3113 key: :upload,
3114 type: :keyword,
3115 description: "Settings for upload pool.",
3116 children: [
3117 %{
3118 key: :max_connections,
3119 type: :integer,
3120 description: "Number workers in the pool.",
3121 suggestions: [25]
3122 },
3123 %{
3124 key: :timeout,
3125 type: :integer,
3126 description: "Timeout while `hackney` will wait for response.",
3127 suggestions: [300_000]
3128 }
3129 ]
3130 }
3131 ]
3132 },
3133 %{
3134 group: :pleroma,
3135 key: :restrict_unauthenticated,
3136 label: "Restrict Unauthenticated",
3137 type: :group,
3138 description:
3139 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3140 children: [
3141 %{
3142 key: :timelines,
3143 type: :map,
3144 description: "Settings for public and federated timelines.",
3145 children: [
3146 %{
3147 key: :local,
3148 type: :boolean,
3149 description: "Disallow view public timeline."
3150 },
3151 %{
3152 key: :federated,
3153 type: :boolean,
3154 description: "Disallow view federated timeline."
3155 }
3156 ]
3157 },
3158 %{
3159 key: :profiles,
3160 type: :map,
3161 description: "Settings for user profiles.",
3162 children: [
3163 %{
3164 key: :local,
3165 type: :boolean,
3166 description: "Disallow view local user profiles."
3167 },
3168 %{
3169 key: :remote,
3170 type: :boolean,
3171 description: "Disallow view remote user profiles."
3172 }
3173 ]
3174 },
3175 %{
3176 key: :activities,
3177 type: :map,
3178 description: "Settings for statuses.",
3179 children: [
3180 %{
3181 key: :local,
3182 type: :boolean,
3183 description: "Disallow view local statuses."
3184 },
3185 %{
3186 key: :remote,
3187 type: :boolean,
3188 description: "Disallow view remote statuses."
3189 }
3190 ]
3191 }
3192 ]
3193 },
3194 %{
3195 group: :pleroma,
3196 key: Pleroma.Web.ApiSpec.CastAndValidate,
3197 type: :group,
3198 children: [
3199 %{
3200 key: :strict,
3201 type: :boolean,
3202 description:
3203 "Enables strict input validation (useful in development, not recommended in production)"
3204 }
3205 ]
3206 },
3207 %{
3208 group: :pleroma,
3209 key: :instances_favicons,
3210 type: :group,
3211 description: "Control favicons for instances",
3212 children: [
3213 %{
3214 key: :enabled,
3215 type: :boolean,
3216 description: "Allow/disallow displaying and getting instances favicons"
3217 }
3218 ]
3219 },
3220 %{
3221 group: :ex_aws,
3222 key: :s3,
3223 type: :group,
3224 descriptions: "S3 service related settings",
3225 children: [
3226 %{
3227 key: :access_key_id,
3228 type: :string,
3229 description: "S3 access key ID",
3230 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3231 },
3232 %{
3233 key: :secret_access_key,
3234 type: :string,
3235 description: "Secret access key",
3236 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3237 },
3238 %{
3239 key: :host,
3240 type: :string,
3241 description: "S3 host",
3242 suggestions: ["s3.eu-central-1.amazonaws.com"]
3243 },
3244 %{
3245 key: :region,
3246 type: :string,
3247 description: "S3 region (for AWS)",
3248 suggestions: ["us-east-1"]
3249 }
3250 ]
3251 },
3252 %{
3253 group: :pleroma,
3254 key: :frontends,
3255 type: :group,
3256 description: "Installed frontends management",
3257 children: [
3258 %{
3259 key: :primary,
3260 type: :map,
3261 description: "Primary frontend, the one that is served for all pages by default",
3262 children: installed_frontend_options
3263 },
3264 %{
3265 key: :admin,
3266 type: :map,
3267 description: "Admin frontend",
3268 children: installed_frontend_options
3269 },
3270 %{
3271 key: :available,
3272 type: :map,
3273 description:
3274 "A map containing available frontends and parameters for their installation.",
3275 children: frontend_options
3276 }
3277 ]
3278 },
3279 %{
3280 group: :pleroma,
3281 key: Pleroma.Web.Preload,
3282 type: :group,
3283 description: "Preload-related settings",
3284 children: [
3285 %{
3286 key: :providers,
3287 type: {:list, :module},
3288 description: "List of preload providers to enable",
3289 suggestions: [
3290 Pleroma.Web.Preload.Providers.Instance,
3291 Pleroma.Web.Preload.Providers.User,
3292 Pleroma.Web.Preload.Providers.Timelines,
3293 Pleroma.Web.Preload.Providers.StatusNet
3294 ]
3295 }
3296 ]
3297 },
3298 %{
3299 group: :pleroma,
3300 key: :majic_pool,
3301 type: :group,
3302 description: "Majic/libmagic configuration",
3303 children: [
3304 %{
3305 key: :size,
3306 type: :integer,
3307 description: "Number of majic workers to start.",
3308 suggestions: [2]
3309 }
3310 ]
3311 },
3312 %{
3313 group: :pleroma,
3314 key: Pleroma.User.Backup,
3315 type: :group,
3316 description: "Account Backup",
3317 children: [
3318 %{
3319 key: :purge_after_days,
3320 type: :integer,
3321 description: "Remove backup achives after N days",
3322 suggestions: [30]
3323 },
3324 %{
3325 key: :limit_days,
3326 type: :integer,
3327 description: "Limit user to export not more often than once per N days",
3328 suggestions: [7]
3329 }
3330 ]
3331 },
3332 %{
3333 group: :prometheus,
3334 key: Pleroma.Web.Endpoint.MetricsExporter,
3335 type: :group,
3336 description: "Prometheus app metrics endpoint configuration",
3337 children: [
3338 %{
3339 key: :enabled,
3340 type: :boolean,
3341 description: "[Pleroma extension] Enables app metrics endpoint."
3342 },
3343 %{
3344 key: :ip_whitelist,
3345 label: "IP Whitelist",
3346 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3347 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3348 },
3349 %{
3350 key: :auth,
3351 type: [:boolean, :tuple],
3352 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3353 suggestion: [false, {:basic, "myusername", "mypassword"}]
3354 },
3355 %{
3356 key: :path,
3357 type: :string,
3358 description: "App metrics endpoint URI path.",
3359 suggestions: ["/api/pleroma/app_metrics"]
3360 },
3361 %{
3362 key: :format,
3363 type: :atom,
3364 description: "App metrics endpoint output format.",
3365 suggestions: [:text, :protobuf]
3366 }
3367 ]
3368 },
3369 %{
3370 group: :pleroma,
3371 key: ConcurrentLimiter,
3372 type: :group,
3373 description: "Limits configuration for background tasks.",
3374 children: [
3375 %{
3376 key: Pleroma.Web.RichMedia.Helpers,
3377 type: :keyword,
3378 description: "Concurrent limits configuration for getting RichMedia for activities.",
3379 suggestions: [max_running: 5, max_waiting: 5],
3380 children: [
3381 %{
3382 key: :max_running,
3383 type: :integer,
3384 description: "Max running concurrently jobs.",
3385 suggestion: [5]
3386 },
3387 %{
3388 key: :max_waiting,
3389 type: :integer,
3390 description: "Max waiting jobs.",
3391 suggestion: [5]
3392 }
3393 ]
3394 },
3395 %{
3396 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3397 type: :keyword,
3398 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3399 suggestions: [max_running: 5, max_waiting: 5],
3400 children: [
3401 %{
3402 key: :max_running,
3403 type: :integer,
3404 description: "Max running concurrently jobs.",
3405 suggestion: [5]
3406 },
3407 %{
3408 key: :max_waiting,
3409 type: :integer,
3410 description: "Max waiting jobs.",
3411 suggestion: [5]
3412 }
3413 ]
3414 }
3415 ]
3416 }
3417 ]
Fork of https://akkoma.dev/AkkomaGang/akkoma.git