projects / akkoma / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Merge branch 'restricted-moderators' 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 key: :profile_directory,
942 type: :boolean,
943 description: "Enable profile directory."
944 },
945 %{
946 key: :privileged_staff,
947 type: :boolean,
948 description:
949 "Let moderators access sensitive data (e.g. updating user credentials, get password reset token, delete users, index and read private statuses and chats)"
950 }
951 ]
952 },
953 %{
954 group: :pleroma,
955 key: :welcome,
956 type: :group,
957 description: "Welcome messages settings",
958 children: [
959 %{
960 key: :direct_message,
961 type: :keyword,
962 descpiption: "Direct message settings",
963 children: [
964 %{
965 key: :enabled,
966 type: :boolean,
967 description: "Enables sending a direct message to newly registered users"
968 },
969 %{
970 key: :message,
971 type: :string,
972 description: "A message that will be sent to newly registered users",
973 suggestions: [
974 "Hi, @username! Welcome on board!"
975 ]
976 },
977 %{
978 key: :sender_nickname,
979 type: :string,
980 description: "The nickname of the local user that sends a welcome message",
981 suggestions: [
982 "lain"
983 ]
984 }
985 ]
986 },
987 %{
988 key: :chat_message,
989 type: :keyword,
990 descpiption: "Chat message settings",
991 children: [
992 %{
993 key: :enabled,
994 type: :boolean,
995 description: "Enables sending a chat message to newly registered users"
996 },
997 %{
998 key: :message,
999 type: :string,
1000 description:
1001 "A message that will be sent to newly registered users as a chat message",
1002 suggestions: [
1003 "Hello, welcome on board!"
1004 ]
1005 },
1006 %{
1007 key: :sender_nickname,
1008 type: :string,
1009 description: "The nickname of the local user that sends a welcome chat message",
1010 suggestions: [
1011 "lain"
1012 ]
1013 }
1014 ]
1015 },
1016 %{
1017 key: :email,
1018 type: :keyword,
1019 descpiption: "Email message settings",
1020 children: [
1021 %{
1022 key: :enabled,
1023 type: :boolean,
1024 description: "Enables sending an email to newly registered users"
1025 },
1026 %{
1027 key: :sender,
1028 type: [:string, :tuple],
1029 description:
1030 "Email address and/or nickname that will be used to send the welcome email.",
1031 suggestions: [
1032 {"Pleroma App", "welcome@pleroma.app"}
1033 ]
1034 },
1035 %{
1036 key: :subject,
1037 type: :string,
1038 description:
1039 "Subject of the welcome email. EEX template with user and instance_name variables can be used.",
1040 suggestions: ["Welcome to <%= instance_name%>"]
1041 },
1042 %{
1043 key: :html,
1044 type: :string,
1045 description:
1046 "HTML content of the welcome email. EEX template with user and instance_name variables can be used.",
1047 suggestions: ["<h1>Hello <%= user.name%>. Welcome to <%= instance_name%></h1>"]
1048 },
1049 %{
1050 key: :text,
1051 type: :string,
1052 description:
1053 "Text content of the welcome email. EEX template with user and instance_name variables can be used.",
1054 suggestions: ["Hello <%= user.name%>. \n Welcome to <%= instance_name%>\n"]
1055 }
1056 ]
1057 }
1058 ]
1059 },
1060 %{
1061 group: :logger,
1062 type: :group,
1063 description: "Logger-related settings",
1064 children: [
1065 %{
1066 key: :backends,
1067 type: [:atom, :tuple, :module],
1068 description:
1069 "Where logs will be sent, :console - send logs to stdout, { ExSyslogger, :ex_syslogger } - to syslog, Quack.Logger - to Slack.",
1070 suggestions: [:console, {ExSyslogger, :ex_syslogger}, Quack.Logger]
1071 }
1072 ]
1073 },
1074 %{
1075 group: :logger,
1076 type: :group,
1077 key: :ex_syslogger,
1078 label: "ExSyslogger",
1079 description: "ExSyslogger-related settings",
1080 children: [
1081 %{
1082 key: :level,
1083 type: {:dropdown, :atom},
1084 description: "Log level",
1085 suggestions: [:debug, :info, :warn, :error]
1086 },
1087 %{
1088 key: :ident,
1089 type: :string,
1090 description:
1091 "A string that's prepended to every message, and is typically set to the app name",
1092 suggestions: ["pleroma"]
1093 },
1094 %{
1095 key: :format,
1096 type: :string,
1097 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1098 suggestions: ["$metadata[$level] $message"]
1099 },
1100 %{
1101 key: :metadata,
1102 type: {:list, :atom},
1103 suggestions: [:request_id]
1104 }
1105 ]
1106 },
1107 %{
1108 group: :logger,
1109 type: :group,
1110 key: :console,
1111 label: "Console Logger",
1112 description: "Console logger settings",
1113 children: [
1114 %{
1115 key: :level,
1116 type: {:dropdown, :atom},
1117 description: "Log level",
1118 suggestions: [:debug, :info, :warn, :error]
1119 },
1120 %{
1121 key: :format,
1122 type: :string,
1123 description: "Default: \"$date $time [$level] $levelpad$node $metadata $message\"",
1124 suggestions: ["$metadata[$level] $message"]
1125 },
1126 %{
1127 key: :metadata,
1128 type: {:list, :atom},
1129 suggestions: [:request_id]
1130 }
1131 ]
1132 },
1133 %{
1134 group: :quack,
1135 type: :group,
1136 label: "Quack Logger",
1137 description: "Quack-related settings",
1138 children: [
1139 %{
1140 key: :level,
1141 type: {:dropdown, :atom},
1142 description: "Log level",
1143 suggestions: [:debug, :info, :warn, :error]
1144 },
1145 %{
1146 key: :meta,
1147 type: {:list, :atom},
1148 description: "Configure which metadata you want to report on",
1149 suggestions: [
1150 :application,
1151 :module,
1152 :file,
1153 :function,
1154 :line,
1155 :pid,
1156 :crash_reason,
1157 :initial_call,
1158 :registered_name,
1159 :all,
1160 :none
1161 ]
1162 },
1163 %{
1164 key: :webhook_url,
1165 label: "Webhook URL",
1166 type: :string,
1167 description: "Configure the Slack incoming webhook",
1168 suggestions: ["https://hooks.slack.com/services/YOUR-KEY-HERE"]
1169 }
1170 ]
1171 },
1172 %{
1173 group: :pleroma,
1174 key: :frontend_configurations,
1175 type: :group,
1176 description:
1177 "This form can be used to configure a keyword list that keeps the configuration data for any " <>
1178 "kind of frontend. By default, settings for pleroma_fe are configured. If you want to " <>
1179 "add your own configuration your settings all fields must be complete.",
1180 children: [
1181 %{
1182 key: :pleroma_fe,
1183 label: "Pleroma FE",
1184 type: :map,
1185 description: "Settings for Pleroma FE",
1186 suggestions: [
1187 %{
1188 alwaysShowSubjectInput: true,
1189 background: "/static/aurora_borealis.jpg",
1190 collapseMessageWithSubject: false,
1191 greentext: false,
1192 hideFilteredStatuses: false,
1193 hideMutedPosts: false,
1194 hidePostStats: false,
1195 hideSitename: false,
1196 hideUserStats: false,
1197 loginMethod: "password",
1198 logo: "/static/logo.svg",
1199 logoMargin: ".1em",
1200 logoMask: true,
1201 minimalScopesMode: false,
1202 noAttachmentLinks: false,
1203 nsfwCensorImage: "/static/img/nsfw.74818f9.png",
1204 postContentType: "text/plain",
1205 redirectRootLogin: "/main/friends",
1206 redirectRootNoLogin: "/main/all",
1207 scopeCopy: true,
1208 sidebarRight: false,
1209 showFeaturesPanel: true,
1210 showInstanceSpecificPanel: false,
1211 subjectLineBehavior: "email",
1212 theme: "pleroma-dark",
1213 webPushNotifications: false
1214 }
1215 ],
1216 children: [
1217 %{
1218 key: :alwaysShowSubjectInput,
1219 label: "Always show subject input",
1220 type: :boolean,
1221 description: "When disabled, auto-hide the subject field if it's empty"
1222 },
1223 %{
1224 key: :background,
1225 type: {:string, :image},
1226 description:
1227 "URL of the background, unless viewing a user profile with a background that is set",
1228 suggestions: ["/images/city.jpg"]
1229 },
1230 %{
1231 key: :collapseMessageWithSubject,
1232 label: "Collapse message with subject",
1233 type: :boolean,
1234 description:
1235 "When a message has a subject (aka Content Warning), collapse it by default"
1236 },
1237 %{
1238 key: :greentext,
1239 label: "Greentext",
1240 type: :boolean,
1241 description: "Enables green text on lines prefixed with the > character"
1242 },
1243 %{
1244 key: :hideFilteredStatuses,
1245 label: "Hide Filtered Statuses",
1246 type: :boolean,
1247 description: "Hides filtered statuses from timelines"
1248 },
1249 %{
1250 key: :hideMutedPosts,
1251 label: "Hide Muted Posts",
1252 type: :boolean,
1253 description: "Hides muted statuses from timelines"
1254 },
1255 %{
1256 key: :hidePostStats,
1257 label: "Hide post stats",
1258 type: :boolean,
1259 description: "Hide notices statistics (repeats, favorites, ...)"
1260 },
1261 %{
1262 key: :hideSitename,
1263 label: "Hide Sitename",
1264 type: :boolean,
1265 description: "Hides instance name from PleromaFE banner"
1266 },
1267 %{
1268 key: :hideUserStats,
1269 label: "Hide user stats",
1270 type: :boolean,
1271 description:
1272 "Hide profile statistics (posts, posts per day, followers, followings, ...)"
1273 },
1274 %{
1275 key: :logo,
1276 type: {:string, :image},
1277 description: "URL of the logo, defaults to Pleroma's logo",
1278 suggestions: ["/static/logo.svg"]
1279 },
1280 %{
1281 key: :logoMargin,
1282 label: "Logo margin",
1283 type: :string,
1284 description:
1285 "Allows you to adjust vertical margins between logo boundary and navbar borders. " <>
1286 "The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout.",
1287 suggestions: [".1em"]
1288 },
1289 %{
1290 key: :logoMask,
1291 label: "Logo mask",
1292 type: :boolean,
1293 description:
1294 "By default it assumes logo used will be monochrome with alpha channel to be compatible with both light and dark themes. " <>
1295 "If you want a colorful logo you must disable logoMask."
1296 },
1297 %{
1298 key: :minimalScopesMode,
1299 label: "Minimal scopes mode",
1300 type: :boolean,
1301 description:
1302 "Limit scope selection to Direct, User default, and Scope of post replying to. " <>
1303 "Also prevents replying to a DM with a public post from PleromaFE."
1304 },
1305 %{
1306 key: :nsfwCensorImage,
1307 label: "NSFW Censor Image",
1308 type: {:string, :image},
1309 description:
1310 "URL of the image to use for hiding NSFW media attachments in the timeline",
1311 suggestions: ["/static/img/nsfw.74818f9.png"]
1312 },
1313 %{
1314 key: :postContentType,
1315 label: "Post Content Type",
1316 type: {:dropdown, :atom},
1317 description: "Default post formatting option",
1318 suggestions: ["text/plain", "text/html", "text/markdown", "text/bbcode"]
1319 },
1320 %{
1321 key: :redirectRootNoLogin,
1322 label: "Redirect root no login",
1323 type: :string,
1324 description:
1325 "Relative URL which indicates where to redirect when a user isn't logged in",
1326 suggestions: ["/main/all"]
1327 },
1328 %{
1329 key: :redirectRootLogin,
1330 label: "Redirect root login",
1331 type: :string,
1332 description:
1333 "Relative URL which indicates where to redirect when a user is logged in",
1334 suggestions: ["/main/friends"]
1335 },
1336 %{
1337 key: :scopeCopy,
1338 label: "Scope copy",
1339 type: :boolean,
1340 description: "Copy the scope (private/unlisted/public) in replies to posts by default"
1341 },
1342 %{
1343 key: :sidebarRight,
1344 label: "Sidebar on Right",
1345 type: :boolean,
1346 description: "Change alignment of sidebar and panels to the right"
1347 },
1348 %{
1349 key: :showFeaturesPanel,
1350 label: "Show instance features panel",
1351 type: :boolean,
1352 description:
1353 "Enables panel displaying functionality of the instance on the About page"
1354 },
1355 %{
1356 key: :showInstanceSpecificPanel,
1357 label: "Show instance specific panel",
1358 type: :boolean,
1359 description: "Whether to show the instance's custom panel"
1360 },
1361 %{
1362 key: :subjectLineBehavior,
1363 label: "Subject line behavior",
1364 type: :string,
1365 description: "Allows changing the default behaviour of subject lines in replies.
1366 `email`: copy and preprend re:, as in email,
1367 `masto`: copy verbatim, as in Mastodon,
1368 `noop`: don't copy the subject.",
1369 suggestions: ["email", "masto", "noop"]
1370 },
1371 %{
1372 key: :theme,
1373 type: :string,
1374 description: "Which theme to use. Available themes are defined in styles.json",
1375 suggestions: ["pleroma-dark"]
1376 }
1377 ]
1378 }
1379 ]
1380 },
1381 %{
1382 group: :pleroma,
1383 key: :assets,
1384 type: :group,
1385 description:
1386 "This section configures assets to be used with various frontends. Currently the only option relates to mascots on the mastodon frontend",
1387 children: [
1388 %{
1389 key: :mascots,
1390 type: {:keyword, :map},
1391 description:
1392 "Keyword of mascots, each element must contain both an URL and a mime_type key",
1393 suggestions: [
1394 pleroma_fox_tan: %{
1395 url: "/images/pleroma-fox-tan-smol.png",
1396 mime_type: "image/png"
1397 },
1398 pleroma_fox_tan_shy: %{
1399 url: "/images/pleroma-fox-tan-shy.png",
1400 mime_type: "image/png"
1401 }
1402 ]
1403 },
1404 %{
1405 key: :default_mascot,
1406 type: :atom,
1407 description:
1408 "This will be used as the default mascot on MastoFE. Default: `:pleroma_fox_tan`",
1409 suggestions: [
1410 :pleroma_fox_tan
1411 ]
1412 },
1413 %{
1414 key: :default_user_avatar,
1415 type: {:string, :image},
1416 description: "URL of the default user avatar",
1417 suggestions: ["/images/avi.png"]
1418 }
1419 ]
1420 },
1421 %{
1422 group: :pleroma,
1423 key: :manifest,
1424 type: :group,
1425 description:
1426 "This section describe PWA manifest instance-specific values. Currently this option relate only for MastoFE.",
1427 children: [
1428 %{
1429 key: :icons,
1430 type: {:list, :map},
1431 description: "Describe the icons of the app",
1432 suggestion: [
1433 %{
1434 src: "/static/logo.png"
1435 },
1436 %{
1437 src: "/static/icon.png",
1438 type: "image/png"
1439 },
1440 %{
1441 src: "/static/icon.ico",
1442 sizes: "72x72 96x96 128x128 256x256"
1443 }
1444 ]
1445 },
1446 %{
1447 key: :theme_color,
1448 type: :string,
1449 description: "Describe the theme color of the app",
1450 suggestions: ["#282c37", "mediumpurple"]
1451 },
1452 %{
1453 key: :background_color,
1454 type: :string,
1455 description: "Describe the background color of the app",
1456 suggestions: ["#191b22", "aliceblue"]
1457 }
1458 ]
1459 },
1460 %{
1461 group: :pleroma,
1462 key: :media_proxy,
1463 type: :group,
1464 description: "Media proxy",
1465 children: [
1466 %{
1467 key: :enabled,
1468 type: :boolean,
1469 description: "Enables proxying of remote media via the instance's proxy"
1470 },
1471 %{
1472 key: :base_url,
1473 label: "Base URL",
1474 type: :string,
1475 description:
1476 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1477 suggestions: ["https://example.com"]
1478 },
1479 %{
1480 key: :invalidation,
1481 type: :keyword,
1482 descpiption: "",
1483 suggestions: [
1484 enabled: true,
1485 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1486 ],
1487 children: [
1488 %{
1489 key: :enabled,
1490 type: :boolean,
1491 description: "Enables media cache object invalidation."
1492 },
1493 %{
1494 key: :provider,
1495 type: :module,
1496 description: "Module which will be used to purge objects from the cache.",
1497 suggestions: [
1498 Pleroma.Web.MediaProxy.Invalidation.Script,
1499 Pleroma.Web.MediaProxy.Invalidation.Http
1500 ]
1501 }
1502 ]
1503 },
1504 %{
1505 key: :proxy_opts,
1506 label: "Advanced MediaProxy Options",
1507 type: :keyword,
1508 description: "Internal Pleroma.ReverseProxy settings",
1509 suggestions: [
1510 redirect_on_failure: false,
1511 max_body_length: 25 * 1_048_576,
1512 max_read_duration: 30_000
1513 ],
1514 children: [
1515 %{
1516 key: :redirect_on_failure,
1517 type: :boolean,
1518 description: """
1519 Redirects the client to the origin server upon encountering HTTP errors.\n
1520 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1521 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1522 IP addresses of your users to the other servers, bypassing the MediaProxy.
1523 """
1524 },
1525 %{
1526 key: :max_body_length,
1527 type: :integer,
1528 description:
1529 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1530 },
1531 %{
1532 key: :max_read_duration,
1533 type: :integer,
1534 description: "Timeout (in milliseconds) of GET request to the remote URI."
1535 }
1536 ]
1537 },
1538 %{
1539 key: :whitelist,
1540 type: {:list, :string},
1541 description: "List of hosts with scheme to bypass the MediaProxy",
1542 suggestions: ["http://example.com"]
1543 }
1544 ]
1545 },
1546 %{
1547 group: :pleroma,
1548 key: :media_preview_proxy,
1549 type: :group,
1550 description: "Media preview proxy",
1551 children: [
1552 %{
1553 key: :enabled,
1554 type: :boolean,
1555 description:
1556 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1557 },
1558 %{
1559 key: :thumbnail_max_width,
1560 type: :integer,
1561 description:
1562 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1563 },
1564 %{
1565 key: :thumbnail_max_height,
1566 type: :integer,
1567 description:
1568 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1569 },
1570 %{
1571 key: :image_quality,
1572 type: :integer,
1573 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1574 },
1575 %{
1576 key: :min_content_length,
1577 type: :integer,
1578 description:
1579 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1580 }
1581 ]
1582 },
1583 %{
1584 group: :pleroma,
1585 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1586 type: :group,
1587 description: "HTTP invalidate settings",
1588 children: [
1589 %{
1590 key: :method,
1591 type: :atom,
1592 description: "HTTP method of request. Default: :purge"
1593 },
1594 %{
1595 key: :headers,
1596 type: {:keyword, :string},
1597 description: "HTTP headers of request",
1598 suggestions: [{"x-refresh", 1}]
1599 },
1600 %{
1601 key: :options,
1602 type: :keyword,
1603 description: "Request options",
1604 children: [
1605 %{
1606 key: :params,
1607 type: {:map, :string}
1608 }
1609 ]
1610 }
1611 ]
1612 },
1613 %{
1614 group: :pleroma,
1615 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1616 type: :group,
1617 description: "Invalidation script settings",
1618 children: [
1619 %{
1620 key: :script_path,
1621 type: :string,
1622 description: "Path to executable script which will purge cached items.",
1623 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1624 },
1625 %{
1626 key: :url_format,
1627 label: "URL Format",
1628 type: :string,
1629 description:
1630 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1631 suggestions: [":htcacheclean"]
1632 }
1633 ]
1634 },
1635 %{
1636 group: :pleroma,
1637 key: :gopher,
1638 type: :group,
1639 description: "Gopher settings",
1640 children: [
1641 %{
1642 key: :enabled,
1643 type: :boolean,
1644 description: "Enables the gopher interface"
1645 },
1646 %{
1647 key: :ip,
1648 label: "IP",
1649 type: :tuple,
1650 description: "IP address to bind to",
1651 suggestions: [{0, 0, 0, 0}]
1652 },
1653 %{
1654 key: :port,
1655 type: :integer,
1656 description: "Port to bind to",
1657 suggestions: [9999]
1658 },
1659 %{
1660 key: :dstport,
1661 type: :integer,
1662 description: "Port advertised in URLs (optional, defaults to port)",
1663 suggestions: [9999]
1664 }
1665 ]
1666 },
1667 %{
1668 group: :pleroma,
1669 key: :activitypub,
1670 label: "ActivityPub",
1671 type: :group,
1672 description: "ActivityPub-related settings",
1673 children: [
1674 %{
1675 key: :unfollow_blocked,
1676 type: :boolean,
1677 description: "Whether blocks result in people getting unfollowed"
1678 },
1679 %{
1680 key: :outgoing_blocks,
1681 type: :boolean,
1682 description: "Whether to federate blocks to other instances"
1683 },
1684 %{
1685 key: :blockers_visible,
1686 type: :boolean,
1687 description: "Whether a user can see someone who has blocked them"
1688 },
1689 %{
1690 key: :sign_object_fetches,
1691 type: :boolean,
1692 description: "Sign object fetches with HTTP signatures"
1693 },
1694 %{
1695 key: :note_replies_output_limit,
1696 type: :integer,
1697 description:
1698 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1699 },
1700 %{
1701 key: :follow_handshake_timeout,
1702 type: :integer,
1703 description: "Following handshake timeout",
1704 suggestions: [500]
1705 }
1706 ]
1707 },
1708 %{
1709 group: :pleroma,
1710 key: :http_security,
1711 label: "HTTP security",
1712 type: :group,
1713 description: "HTTP security settings",
1714 children: [
1715 %{
1716 key: :enabled,
1717 type: :boolean,
1718 description: "Whether the managed content security policy is enabled"
1719 },
1720 %{
1721 key: :sts,
1722 label: "STS",
1723 type: :boolean,
1724 description: "Whether to additionally send a Strict-Transport-Security header"
1725 },
1726 %{
1727 key: :sts_max_age,
1728 label: "STS max age",
1729 type: :integer,
1730 description: "The maximum age for the Strict-Transport-Security header if sent",
1731 suggestions: [31_536_000]
1732 },
1733 %{
1734 key: :ct_max_age,
1735 label: "CT max age",
1736 type: :integer,
1737 description: "The maximum age for the Expect-CT header if sent",
1738 suggestions: [2_592_000]
1739 },
1740 %{
1741 key: :referrer_policy,
1742 type: :string,
1743 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1744 suggestions: ["same-origin", "no-referrer"]
1745 },
1746 %{
1747 key: :report_uri,
1748 label: "Report URI",
1749 type: :string,
1750 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1751 suggestions: ["https://example.com/report-uri"]
1752 }
1753 ]
1754 },
1755 %{
1756 group: :web_push_encryption,
1757 key: :vapid_details,
1758 label: "Vapid Details",
1759 type: :group,
1760 description:
1761 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1762 children: [
1763 %{
1764 key: :subject,
1765 type: :string,
1766 description:
1767 "A mailto link for the administrative contact." <>
1768 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1769 suggestions: ["mailto:moderators@pleroma.com"]
1770 },
1771 %{
1772 key: :public_key,
1773 type: :string,
1774 description: "VAPID public key",
1775 suggestions: ["Public key"]
1776 },
1777 %{
1778 key: :private_key,
1779 type: :string,
1780 description: "VAPID private key",
1781 suggestions: ["Private key"]
1782 }
1783 ]
1784 },
1785 %{
1786 group: :pleroma,
1787 key: Pleroma.Captcha,
1788 type: :group,
1789 description: "Captcha-related settings",
1790 children: [
1791 %{
1792 key: :enabled,
1793 type: :boolean,
1794 description: "Whether the captcha should be shown on registration"
1795 },
1796 %{
1797 key: :method,
1798 type: :module,
1799 description: "The method/service to use for captcha",
1800 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1801 },
1802 %{
1803 key: :seconds_valid,
1804 type: :integer,
1805 description: "The time in seconds for which the captcha is valid",
1806 suggestions: [60]
1807 }
1808 ]
1809 },
1810 %{
1811 group: :pleroma,
1812 key: Pleroma.Captcha.Kocaptcha,
1813 type: :group,
1814 description:
1815 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1816 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1817 children: [
1818 %{
1819 key: :endpoint,
1820 type: :string,
1821 description: "The kocaptcha endpoint to use",
1822 suggestions: ["https://captcha.kotobank.ch"]
1823 }
1824 ]
1825 },
1826 %{
1827 group: :pleroma,
1828 label: "Pleroma Admin Token",
1829 type: :group,
1830 description:
1831 "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)",
1832 children: [
1833 %{
1834 key: :admin_token,
1835 type: :string,
1836 description: "Admin token",
1837 suggestions: [
1838 "Please use a high entropy string or UUID"
1839 ]
1840 }
1841 ]
1842 },
1843 %{
1844 group: :pleroma,
1845 key: Oban,
1846 type: :group,
1847 description:
1848 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1849 children: [
1850 %{
1851 key: :log,
1852 type: {:dropdown, :atom},
1853 description: "Logs verbose mode",
1854 suggestions: [false, :error, :warn, :info, :debug]
1855 },
1856 %{
1857 key: :queues,
1858 type: {:keyword, :integer},
1859 description:
1860 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1861 suggestions: [
1862 activity_expiration: 10,
1863 attachments_cleanup: 5,
1864 background: 5,
1865 federator_incoming: 50,
1866 federator_outgoing: 50,
1867 mailer: 10,
1868 scheduled_activities: 10,
1869 transmogrifier: 20,
1870 web_push: 50
1871 ],
1872 children: [
1873 %{
1874 key: :activity_expiration,
1875 type: :integer,
1876 description: "Activity expiration queue",
1877 suggestions: [10]
1878 },
1879 %{
1880 key: :backup,
1881 type: :integer,
1882 description: "Backup queue",
1883 suggestions: [1]
1884 },
1885 %{
1886 key: :attachments_cleanup,
1887 type: :integer,
1888 description: "Attachment deletion queue",
1889 suggestions: [5]
1890 },
1891 %{
1892 key: :background,
1893 type: :integer,
1894 description: "Background queue",
1895 suggestions: [5]
1896 },
1897 %{
1898 key: :federator_incoming,
1899 type: :integer,
1900 description: "Incoming federation queue",
1901 suggestions: [50]
1902 },
1903 %{
1904 key: :federator_outgoing,
1905 type: :integer,
1906 description: "Outgoing federation queue",
1907 suggestions: [50]
1908 },
1909 %{
1910 key: :mailer,
1911 type: :integer,
1912 description: "Email sender queue, see Pleroma.Emails.Mailer",
1913 suggestions: [10]
1914 },
1915 %{
1916 key: :scheduled_activities,
1917 type: :integer,
1918 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1919 suggestions: [10]
1920 },
1921 %{
1922 key: :transmogrifier,
1923 type: :integer,
1924 description: "Transmogrifier queue",
1925 suggestions: [20]
1926 },
1927 %{
1928 key: :web_push,
1929 type: :integer,
1930 description: "Web push notifications queue",
1931 suggestions: [50]
1932 }
1933 ]
1934 },
1935 %{
1936 key: :crontab,
1937 type: {:list, :tuple},
1938 description: "Settings for cron background jobs",
1939 suggestions: [
1940 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1941 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1942 ]
1943 }
1944 ]
1945 },
1946 %{
1947 group: :pleroma,
1948 key: :workers,
1949 type: :group,
1950 description: "Includes custom worker options not interpretable directly by `Oban`",
1951 children: [
1952 %{
1953 key: :retries,
1954 type: {:keyword, :integer},
1955 description: "Max retry attempts for failed jobs, per `Oban` queue",
1956 suggestions: [
1957 federator_incoming: 5,
1958 federator_outgoing: 5
1959 ]
1960 }
1961 ]
1962 },
1963 %{
1964 group: :pleroma,
1965 key: Pleroma.Web.Metadata,
1966 type: :group,
1967 description: "Metadata-related settings",
1968 children: [
1969 %{
1970 key: :providers,
1971 type: {:list, :module},
1972 description: "List of metadata providers to enable",
1973 suggestions: [
1974 Pleroma.Web.Metadata.Providers.OpenGraph,
1975 Pleroma.Web.Metadata.Providers.TwitterCard,
1976 Pleroma.Web.Metadata.Providers.RelMe,
1977 Pleroma.Web.Metadata.Providers.Feed
1978 ]
1979 },
1980 %{
1981 key: :unfurl_nsfw,
1982 label: "Unfurl NSFW",
1983 type: :boolean,
1984 description: "When enabled NSFW attachments will be shown in previews"
1985 }
1986 ]
1987 },
1988 %{
1989 group: :pleroma,
1990 key: :rich_media,
1991 type: :group,
1992 description:
1993 "If enabled the instance will parse metadata from attached links to generate link previews",
1994 children: [
1995 %{
1996 key: :enabled,
1997 type: :boolean,
1998 description: "Enables RichMedia parsing of URLs"
1999 },
2000 %{
2001 key: :ignore_hosts,
2002 type: {:list, :string},
2003 description: "List of hosts which will be ignored by the metadata parser",
2004 suggestions: ["accounts.google.com", "xss.website"]
2005 },
2006 %{
2007 key: :ignore_tld,
2008 label: "Ignore TLD",
2009 type: {:list, :string},
2010 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2011 suggestions: ["local", "localdomain", "lan"]
2012 },
2013 %{
2014 key: :parsers,
2015 type: {:list, :module},
2016 description:
2017 "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.",
2018 suggestions: [
2019 Pleroma.Web.RichMedia.Parsers.OEmbed,
2020 Pleroma.Web.RichMedia.Parsers.TwitterCard
2021 ]
2022 },
2023 %{
2024 key: :ttl_setters,
2025 label: "TTL setters",
2026 type: {:list, :module},
2027 description:
2028 "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.",
2029 suggestions: [
2030 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2031 ]
2032 },
2033 %{
2034 key: :failure_backoff,
2035 type: :integer,
2036 description:
2037 "Amount of milliseconds after request failure, during which the request will not be retried.",
2038 suggestions: [60_000]
2039 }
2040 ]
2041 },
2042 %{
2043 group: :pleroma,
2044 key: Pleroma.Formatter,
2045 label: "Linkify",
2046 type: :group,
2047 description:
2048 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2049 children: [
2050 %{
2051 key: :class,
2052 type: [:string, :boolean],
2053 description: "Specify the class to be added to the generated link. Disable to clear.",
2054 suggestions: ["auto-linker", false]
2055 },
2056 %{
2057 key: :rel,
2058 type: [:string, :boolean],
2059 description: "Override the rel attribute. Disable to clear.",
2060 suggestions: ["ugc", "noopener noreferrer", false]
2061 },
2062 %{
2063 key: :new_window,
2064 type: :boolean,
2065 description: "Link URLs will open in a new window/tab."
2066 },
2067 %{
2068 key: :truncate,
2069 type: [:integer, :boolean],
2070 description:
2071 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2072 suggestions: [15, false]
2073 },
2074 %{
2075 key: :strip_prefix,
2076 type: :boolean,
2077 description: "Strip the scheme prefix."
2078 },
2079 %{
2080 key: :extra,
2081 type: :boolean,
2082 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2083 },
2084 %{
2085 key: :validate_tld,
2086 type: [:atom, :boolean],
2087 description:
2088 "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)",
2089 suggestions: [:no_scheme, true]
2090 }
2091 ]
2092 },
2093 %{
2094 group: :pleroma,
2095 key: Pleroma.ScheduledActivity,
2096 type: :group,
2097 description: "Scheduled activities settings",
2098 children: [
2099 %{
2100 key: :daily_user_limit,
2101 type: :integer,
2102 description:
2103 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2104 suggestions: [25]
2105 },
2106 %{
2107 key: :total_user_limit,
2108 type: :integer,
2109 description:
2110 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2111 suggestions: [300]
2112 },
2113 %{
2114 key: :enabled,
2115 type: :boolean,
2116 description: "Whether scheduled activities are sent to the job queue to be executed"
2117 }
2118 ]
2119 },
2120 %{
2121 group: :pleroma,
2122 key: Pleroma.Workers.PurgeExpiredActivity,
2123 type: :group,
2124 description: "Expired activities settings",
2125 children: [
2126 %{
2127 key: :enabled,
2128 type: :boolean,
2129 description: "Enables expired activities addition & deletion"
2130 },
2131 %{
2132 key: :min_lifetime,
2133 type: :integer,
2134 description: "Minimum lifetime for ephemeral activity (in seconds)",
2135 suggestions: [600]
2136 }
2137 ]
2138 },
2139 %{
2140 group: :pleroma,
2141 label: "Pleroma Authenticator",
2142 type: :group,
2143 description: "Authenticator",
2144 children: [
2145 %{
2146 key: Pleroma.Web.Auth.Authenticator,
2147 type: :module,
2148 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2149 }
2150 ]
2151 },
2152 %{
2153 group: :pleroma,
2154 key: :ldap,
2155 label: "LDAP",
2156 type: :group,
2157 description:
2158 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2159 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2160 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2161 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2162 children: [
2163 %{
2164 key: :enabled,
2165 type: :boolean,
2166 description: "Enables LDAP authentication"
2167 },
2168 %{
2169 key: :host,
2170 type: :string,
2171 description: "LDAP server hostname",
2172 suggestions: ["localhosts"]
2173 },
2174 %{
2175 key: :port,
2176 type: :integer,
2177 description: "LDAP port, e.g. 389 or 636",
2178 suggestions: [389, 636]
2179 },
2180 %{
2181 key: :ssl,
2182 label: "SSL",
2183 type: :boolean,
2184 description: "Enable to use SSL, usually implies the port 636"
2185 },
2186 %{
2187 key: :sslopts,
2188 label: "SSL options",
2189 type: :keyword,
2190 description: "Additional SSL options",
2191 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2192 children: [
2193 %{
2194 key: :cacertfile,
2195 type: :string,
2196 description: "Path to file with PEM encoded cacerts",
2197 suggestions: ["path/to/file/with/PEM/cacerts"]
2198 },
2199 %{
2200 key: :verify,
2201 type: :atom,
2202 description: "Type of cert verification",
2203 suggestions: [:verify_peer]
2204 }
2205 ]
2206 },
2207 %{
2208 key: :tls,
2209 label: "TLS",
2210 type: :boolean,
2211 description: "Enable to use STARTTLS, usually implies the port 389"
2212 },
2213 %{
2214 key: :tlsopts,
2215 label: "TLS options",
2216 type: :keyword,
2217 description: "Additional TLS options",
2218 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2219 children: [
2220 %{
2221 key: :cacertfile,
2222 type: :string,
2223 description: "Path to file with PEM encoded cacerts",
2224 suggestions: ["path/to/file/with/PEM/cacerts"]
2225 },
2226 %{
2227 key: :verify,
2228 type: :atom,
2229 description: "Type of cert verification",
2230 suggestions: [:verify_peer]
2231 }
2232 ]
2233 },
2234 %{
2235 key: :base,
2236 type: :string,
2237 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2238 suggestions: ["dc=example,dc=com"]
2239 },
2240 %{
2241 key: :uid,
2242 label: "UID",
2243 type: :string,
2244 description:
2245 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2246 suggestions: ["cn"]
2247 }
2248 ]
2249 },
2250 %{
2251 group: :pleroma,
2252 key: :auth,
2253 type: :group,
2254 description: "Authentication / authorization settings",
2255 children: [
2256 %{
2257 key: :enforce_oauth_admin_scope_usage,
2258 label: "Enforce OAuth admin scope usage",
2259 type: :boolean,
2260 description:
2261 "OAuth admin scope requirement toggle. " <>
2262 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2263 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2264 "`is_admin` user flag grants access to admin-specific actions."
2265 },
2266 %{
2267 key: :auth_template,
2268 type: :string,
2269 description:
2270 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2271 suggestions: ["show.html"]
2272 },
2273 %{
2274 key: :oauth_consumer_template,
2275 label: "OAuth consumer template",
2276 type: :string,
2277 description:
2278 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2279 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2280 suggestions: ["consumer.html"]
2281 },
2282 %{
2283 key: :oauth_consumer_strategies,
2284 label: "OAuth consumer strategies",
2285 type: {:list, :string},
2286 description:
2287 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2288 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2289 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2290 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2291 }
2292 ]
2293 },
2294 %{
2295 group: :pleroma,
2296 key: :email_notifications,
2297 type: :group,
2298 description: "Email notifications settings",
2299 children: [
2300 %{
2301 key: :digest,
2302 type: :map,
2303 description:
2304 "emails of \"what you've missed\" for users who have been inactive for a while",
2305 suggestions: [
2306 %{
2307 active: false,
2308 schedule: "0 0 * * 0",
2309 interval: 7,
2310 inactivity_threshold: 7
2311 }
2312 ],
2313 children: [
2314 %{
2315 key: :active,
2316 label: "Enabled",
2317 type: :boolean,
2318 description: "Globally enable or disable digest emails"
2319 },
2320 %{
2321 key: :schedule,
2322 type: :string,
2323 description:
2324 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2325 suggestions: ["0 0 * * 0"]
2326 },
2327 %{
2328 key: :interval,
2329 type: :integer,
2330 description: "Minimum interval between digest emails to one user",
2331 suggestions: [7]
2332 },
2333 %{
2334 key: :inactivity_threshold,
2335 type: :integer,
2336 description: "Minimum user inactivity threshold",
2337 suggestions: [7]
2338 }
2339 ]
2340 }
2341 ]
2342 },
2343 %{
2344 group: :pleroma,
2345 key: Pleroma.Emails.UserEmail,
2346 type: :group,
2347 description: "Email template settings",
2348 children: [
2349 %{
2350 key: :logo,
2351 type: {:string, :image},
2352 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2353 suggestions: ["some/path/logo.png"]
2354 },
2355 %{
2356 key: :styling,
2357 type: :map,
2358 description: "A map with color settings for email templates.",
2359 suggestions: [
2360 %{
2361 link_color: "#d8a070",
2362 background_color: "#2C3645",
2363 content_background_color: "#1B2635",
2364 header_color: "#d8a070",
2365 text_color: "#b9b9ba",
2366 text_muted_color: "#b9b9ba"
2367 }
2368 ],
2369 children: [
2370 %{
2371 key: :link_color,
2372 type: :string,
2373 suggestions: ["#d8a070"]
2374 },
2375 %{
2376 key: :background_color,
2377 type: :string,
2378 suggestions: ["#2C3645"]
2379 },
2380 %{
2381 key: :content_background_color,
2382 type: :string,
2383 suggestions: ["#1B2635"]
2384 },
2385 %{
2386 key: :header_color,
2387 type: :string,
2388 suggestions: ["#d8a070"]
2389 },
2390 %{
2391 key: :text_color,
2392 type: :string,
2393 suggestions: ["#b9b9ba"]
2394 },
2395 %{
2396 key: :text_muted_color,
2397 type: :string,
2398 suggestions: ["#b9b9ba"]
2399 }
2400 ]
2401 }
2402 ]
2403 },
2404 %{
2405 group: :pleroma,
2406 key: Pleroma.Emails.NewUsersDigestEmail,
2407 type: :group,
2408 description: "New users admin email digest",
2409 children: [
2410 %{
2411 key: :enabled,
2412 type: :boolean,
2413 description: "Enables new users admin digest email when `true`"
2414 }
2415 ]
2416 },
2417 %{
2418 group: :pleroma,
2419 key: :oauth2,
2420 label: "OAuth2",
2421 type: :group,
2422 description: "Configure OAuth 2 provider capabilities",
2423 children: [
2424 %{
2425 key: :token_expires_in,
2426 type: :integer,
2427 description: "The lifetime in seconds of the access token",
2428 suggestions: [2_592_000]
2429 },
2430 %{
2431 key: :issue_new_refresh_token,
2432 type: :boolean,
2433 description:
2434 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2435 },
2436 %{
2437 key: :clean_expired_tokens,
2438 type: :boolean,
2439 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2440 }
2441 ]
2442 },
2443 %{
2444 group: :pleroma,
2445 key: :emoji,
2446 type: :group,
2447 children: [
2448 %{
2449 key: :shortcode_globs,
2450 type: {:list, :string},
2451 description: "Location of custom emoji files. * can be used as a wildcard.",
2452 suggestions: ["/emoji/custom/**/*.png"]
2453 },
2454 %{
2455 key: :pack_extensions,
2456 type: {:list, :string},
2457 description:
2458 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2459 suggestions: [".png", ".gif"]
2460 },
2461 %{
2462 key: :groups,
2463 type: {:keyword, {:list, :string}},
2464 description:
2465 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2466 " and the value is the location or array of locations. * can be used as a wildcard.",
2467 suggestions: [
2468 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2469 ]
2470 },
2471 %{
2472 key: :default_manifest,
2473 type: :string,
2474 description:
2475 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2476 " Currently only one manifest can be added (no arrays).",
2477 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2478 },
2479 %{
2480 key: :shared_pack_cache_seconds_per_file,
2481 label: "Shared pack cache s/file",
2482 type: :integer,
2483 descpiption:
2484 "When an emoji pack is shared, the archive is created and cached in memory" <>
2485 " for this amount of seconds multiplied by the number of files.",
2486 suggestions: [60]
2487 }
2488 ]
2489 },
2490 %{
2491 group: :pleroma,
2492 key: :rate_limit,
2493 type: :group,
2494 description:
2495 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2496 children: [
2497 %{
2498 key: :search,
2499 type: [:tuple, {:list, :tuple}],
2500 description: "For the search requests (account & status search etc.)",
2501 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2502 },
2503 %{
2504 key: :timeline,
2505 type: [:tuple, {:list, :tuple}],
2506 description: "For requests to timelines (each timeline has it's own limiter)",
2507 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2508 },
2509 %{
2510 key: :app_account_creation,
2511 type: [:tuple, {:list, :tuple}],
2512 description: "For registering user accounts from the same IP address",
2513 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2514 },
2515 %{
2516 key: :relations_actions,
2517 type: [:tuple, {:list, :tuple}],
2518 description: "For actions on relationships with all users (follow, unfollow)",
2519 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2520 },
2521 %{
2522 key: :relation_id_action,
2523 label: "Relation ID action",
2524 type: [:tuple, {:list, :tuple}],
2525 description: "For actions on relation with a specific user (follow, unfollow)",
2526 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2527 },
2528 %{
2529 key: :statuses_actions,
2530 type: [:tuple, {:list, :tuple}],
2531 description:
2532 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2533 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2534 },
2535 %{
2536 key: :status_id_action,
2537 label: "Status ID action",
2538 type: [:tuple, {:list, :tuple}],
2539 description:
2540 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2541 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2542 },
2543 %{
2544 key: :authentication,
2545 type: [:tuple, {:list, :tuple}],
2546 description: "For authentication create / password check / user existence check requests",
2547 suggestions: [{60_000, 15}]
2548 }
2549 ]
2550 },
2551 %{
2552 group: :esshd,
2553 label: "ESSHD",
2554 type: :group,
2555 description:
2556 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2557 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2558 children: [
2559 %{
2560 key: :enabled,
2561 type: :boolean,
2562 description: "Enables SSH"
2563 },
2564 %{
2565 key: :priv_dir,
2566 type: :string,
2567 description: "Dir with SSH keys",
2568 suggestions: ["/some/path/ssh_keys"]
2569 },
2570 %{
2571 key: :handler,
2572 type: :string,
2573 description: "Handler module",
2574 suggestions: ["Pleroma.BBS.Handler"]
2575 },
2576 %{
2577 key: :port,
2578 type: :integer,
2579 description: "Port to connect",
2580 suggestions: [10_022]
2581 },
2582 %{
2583 key: :password_authenticator,
2584 type: :string,
2585 description: "Authenticator module",
2586 suggestions: ["Pleroma.BBS.Authenticator"]
2587 }
2588 ]
2589 },
2590 %{
2591 group: :mime,
2592 label: "Mime Types",
2593 type: :group,
2594 description: "Mime Types settings",
2595 children: [
2596 %{
2597 key: :types,
2598 type: :map,
2599 suggestions: [
2600 %{
2601 "application/xml" => ["xml"],
2602 "application/xrd+xml" => ["xrd+xml"],
2603 "application/jrd+json" => ["jrd+json"],
2604 "application/activity+json" => ["activity+json"],
2605 "application/ld+json" => ["activity+json"]
2606 }
2607 ],
2608 children: [
2609 %{
2610 key: "application/xml",
2611 type: {:list, :string},
2612 suggestions: ["xml"]
2613 },
2614 %{
2615 key: "application/xrd+xml",
2616 type: {:list, :string},
2617 suggestions: ["xrd+xml"]
2618 },
2619 %{
2620 key: "application/jrd+json",
2621 type: {:list, :string},
2622 suggestions: ["jrd+json"]
2623 },
2624 %{
2625 key: "application/activity+json",
2626 type: {:list, :string},
2627 suggestions: ["activity+json"]
2628 },
2629 %{
2630 key: "application/ld+json",
2631 type: {:list, :string},
2632 suggestions: ["activity+json"]
2633 }
2634 ]
2635 }
2636 ]
2637 },
2638 %{
2639 group: :pleroma,
2640 key: :shout,
2641 type: :group,
2642 description: "Pleroma shout settings",
2643 children: [
2644 %{
2645 key: :enabled,
2646 type: :boolean,
2647 description: "Enables the backend Shoutbox chat feature."
2648 },
2649 %{
2650 key: :limit,
2651 type: :integer,
2652 description: "Shout message character limit.",
2653 suggestions: [
2654 5_000
2655 ]
2656 }
2657 ]
2658 },
2659 %{
2660 group: :pleroma,
2661 key: :http,
2662 label: "HTTP",
2663 type: :group,
2664 description: "HTTP settings",
2665 children: [
2666 %{
2667 key: :proxy_url,
2668 label: "Proxy URL",
2669 type: [:string, :tuple],
2670 description: "Proxy URL",
2671 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2672 },
2673 %{
2674 key: :send_user_agent,
2675 type: :boolean
2676 },
2677 %{
2678 key: :user_agent,
2679 type: [:string, :atom],
2680 description:
2681 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2682 suggestions: ["Pleroma", :default]
2683 },
2684 %{
2685 key: :adapter,
2686 type: :keyword,
2687 description: "Adapter specific options",
2688 suggestions: [],
2689 children: [
2690 %{
2691 key: :ssl_options,
2692 type: :keyword,
2693 label: "SSL Options",
2694 description: "SSL options for HTTP adapter",
2695 children: [
2696 %{
2697 key: :versions,
2698 type: {:list, :atom},
2699 description: "List of TLS version to use",
2700 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2701 }
2702 ]
2703 }
2704 ]
2705 }
2706 ]
2707 },
2708 %{
2709 group: :pleroma,
2710 key: :markup,
2711 label: "Markup Settings",
2712 type: :group,
2713 children: [
2714 %{
2715 key: :allow_inline_images,
2716 type: :boolean
2717 },
2718 %{
2719 key: :allow_headings,
2720 type: :boolean
2721 },
2722 %{
2723 key: :allow_tables,
2724 type: :boolean
2725 },
2726 %{
2727 key: :allow_fonts,
2728 type: :boolean
2729 },
2730 %{
2731 key: :scrub_policy,
2732 type: {:list, :module},
2733 description:
2734 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2735 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2736 }
2737 ]
2738 },
2739 %{
2740 group: :pleroma,
2741 key: :user,
2742 type: :group,
2743 children: [
2744 %{
2745 key: :deny_follow_blocked,
2746 type: :boolean
2747 }
2748 ]
2749 },
2750 %{
2751 group: :pleroma,
2752 key: Pleroma.User,
2753 type: :group,
2754 children: [
2755 %{
2756 key: :restricted_nicknames,
2757 type: {:list, :string},
2758 description: "List of nicknames users may not register with.",
2759 suggestions: [
2760 ".well-known",
2761 "~",
2762 "about",
2763 "activities",
2764 "api",
2765 "auth",
2766 "check_password",
2767 "dev",
2768 "friend-requests",
2769 "inbox",
2770 "internal",
2771 "main",
2772 "media",
2773 "nodeinfo",
2774 "notice",
2775 "oauth",
2776 "objects",
2777 "ostatus_subscribe",
2778 "pleroma",
2779 "proxy",
2780 "push",
2781 "registration",
2782 "relay",
2783 "settings",
2784 "status",
2785 "tag",
2786 "user-search",
2787 "user_exists",
2788 "users",
2789 "web"
2790 ]
2791 },
2792 %{
2793 key: :email_blacklist,
2794 type: {:list, :string},
2795 description: "List of email domains users may not register with.",
2796 suggestions: ["mailinator.com", "maildrop.cc"]
2797 }
2798 ]
2799 },
2800 %{
2801 group: :cors_plug,
2802 label: "CORS plug config",
2803 type: :group,
2804 children: [
2805 %{
2806 key: :max_age,
2807 type: :integer,
2808 suggestions: [86_400]
2809 },
2810 %{
2811 key: :methods,
2812 type: {:list, :string},
2813 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2814 },
2815 %{
2816 key: :expose,
2817 type: {:list, :string},
2818 suggestions: [
2819 "Link",
2820 "X-RateLimit-Reset",
2821 "X-RateLimit-Limit",
2822 "X-RateLimit-Remaining",
2823 "X-Request-Id",
2824 "Idempotency-Key"
2825 ]
2826 },
2827 %{
2828 key: :credentials,
2829 type: :boolean
2830 },
2831 %{
2832 key: :headers,
2833 type: {:list, :string},
2834 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2835 }
2836 ]
2837 },
2838 %{
2839 group: :pleroma,
2840 key: Pleroma.Web.Plugs.RemoteIp,
2841 type: :group,
2842 description: """
2843 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2844 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2845 """,
2846 children: [
2847 %{
2848 key: :enabled,
2849 type: :boolean,
2850 description: "Enable/disable the plug. Default: disabled."
2851 },
2852 %{
2853 key: :headers,
2854 type: {:list, :string},
2855 description: """
2856 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2857 """
2858 },
2859 %{
2860 key: :proxies,
2861 type: {:list, :string},
2862 description:
2863 "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."
2864 },
2865 %{
2866 key: :reserved,
2867 type: {:list, :string},
2868 description: """
2869 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"]`
2870 """
2871 }
2872 ]
2873 },
2874 %{
2875 group: :pleroma,
2876 key: :web_cache_ttl,
2877 label: "Web cache TTL",
2878 type: :group,
2879 description:
2880 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2881 children: [
2882 %{
2883 key: :activity_pub,
2884 type: :integer,
2885 description:
2886 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2887 suggestions: [nil]
2888 },
2889 %{
2890 key: :activity_pub_question,
2891 type: :integer,
2892 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2893 suggestions: [30_000]
2894 }
2895 ]
2896 },
2897 %{
2898 group: :pleroma,
2899 key: :static_fe,
2900 label: "Static FE",
2901 type: :group,
2902 description:
2903 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2904 children: [
2905 %{
2906 key: :enabled,
2907 type: :boolean,
2908 description: "Enables the rendering of static HTML. Default: disabled."
2909 }
2910 ]
2911 },
2912 %{
2913 group: :pleroma,
2914 key: :feed,
2915 type: :group,
2916 description: "Configure feed rendering",
2917 children: [
2918 %{
2919 key: :post_title,
2920 type: :map,
2921 description: "Configure title rendering",
2922 children: [
2923 %{
2924 key: :max_length,
2925 type: :integer,
2926 description: "Maximum number of characters before truncating title",
2927 suggestions: [100]
2928 },
2929 %{
2930 key: :omission,
2931 type: :string,
2932 description: "Replacement which will be used after truncating string",
2933 suggestions: ["..."]
2934 }
2935 ]
2936 }
2937 ]
2938 },
2939 %{
2940 group: :pleroma,
2941 key: :mrf_follow_bot,
2942 tab: :mrf,
2943 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2944 label: "MRF FollowBot Policy",
2945 type: :group,
2946 description: "Automatically follows newly discovered accounts.",
2947 children: [
2948 %{
2949 key: :follower_nickname,
2950 type: :string,
2951 description: "The name of the bot account to use for following newly discovered users.",
2952 suggestions: ["followbot"]
2953 }
2954 ]
2955 },
2956 %{
2957 group: :pleroma,
2958 key: :modules,
2959 type: :group,
2960 description: "Custom Runtime Modules",
2961 children: [
2962 %{
2963 key: :runtime_dir,
2964 type: :string,
2965 description: "A path to custom Elixir modules (such as MRF policies)."
2966 }
2967 ]
2968 },
2969 %{
2970 group: :pleroma,
2971 key: :streamer,
2972 type: :group,
2973 description: "Settings for notifications streamer",
2974 children: [
2975 %{
2976 key: :workers,
2977 type: :integer,
2978 description: "Number of workers to send notifications",
2979 suggestions: [3]
2980 },
2981 %{
2982 key: :overflow_workers,
2983 type: :integer,
2984 description: "Maximum number of workers created if pool is empty",
2985 suggestions: [2]
2986 }
2987 ]
2988 },
2989 %{
2990 group: :pleroma,
2991 key: :connections_pool,
2992 type: :group,
2993 description: "Advanced settings for `Gun` connections pool",
2994 children: [
2995 %{
2996 key: :connection_acquisition_wait,
2997 type: :integer,
2998 description:
2999 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3000 suggestions: [250]
3001 },
3002 %{
3003 key: :connection_acquisition_retries,
3004 type: :integer,
3005 description:
3006 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3007 suggestions: [5]
3008 },
3009 %{
3010 key: :max_connections,
3011 type: :integer,
3012 description: "Maximum number of connections in the pool. Default: 250 connections.",
3013 suggestions: [250]
3014 },
3015 %{
3016 key: :connect_timeout,
3017 type: :integer,
3018 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3019 suggestions: [5000]
3020 },
3021 %{
3022 key: :reclaim_multiplier,
3023 type: :integer,
3024 description:
3025 "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",
3026 suggestions: [0.1]
3027 }
3028 ]
3029 },
3030 %{
3031 group: :pleroma,
3032 key: :pools,
3033 type: :group,
3034 description: "Advanced settings for `Gun` workers pools",
3035 children:
3036 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3037 %{
3038 key: pool_name,
3039 type: :keyword,
3040 description: "Settings for #{pool_name} pool.",
3041 children: [
3042 %{
3043 key: :size,
3044 type: :integer,
3045 description: "Maximum number of concurrent requests in the pool.",
3046 suggestions: [50]
3047 },
3048 %{
3049 key: :max_waiting,
3050 type: :integer,
3051 description:
3052 "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",
3053 suggestions: [10]
3054 },
3055 %{
3056 key: :recv_timeout,
3057 type: :integer,
3058 description: "Timeout for the pool while gun will wait for response",
3059 suggestions: [10_000]
3060 }
3061 ]
3062 }
3063 end)
3064 },
3065 %{
3066 group: :pleroma,
3067 key: :hackney_pools,
3068 type: :group,
3069 description: "Advanced settings for `Hackney` connections pools",
3070 children: [
3071 %{
3072 key: :federation,
3073 type: :keyword,
3074 description: "Settings for federation pool.",
3075 children: [
3076 %{
3077 key: :max_connections,
3078 type: :integer,
3079 description: "Number workers in the pool.",
3080 suggestions: [50]
3081 },
3082 %{
3083 key: :timeout,
3084 type: :integer,
3085 description: "Timeout while `hackney` will wait for response.",
3086 suggestions: [150_000]
3087 }
3088 ]
3089 },
3090 %{
3091 key: :media,
3092 type: :keyword,
3093 description: "Settings for media pool.",
3094 children: [
3095 %{
3096 key: :max_connections,
3097 type: :integer,
3098 description: "Number workers in the pool.",
3099 suggestions: [50]
3100 },
3101 %{
3102 key: :timeout,
3103 type: :integer,
3104 description: "Timeout while `hackney` will wait for response.",
3105 suggestions: [150_000]
3106 }
3107 ]
3108 },
3109 %{
3110 key: :upload,
3111 type: :keyword,
3112 description: "Settings for upload pool.",
3113 children: [
3114 %{
3115 key: :max_connections,
3116 type: :integer,
3117 description: "Number workers in the pool.",
3118 suggestions: [25]
3119 },
3120 %{
3121 key: :timeout,
3122 type: :integer,
3123 description: "Timeout while `hackney` will wait for response.",
3124 suggestions: [300_000]
3125 }
3126 ]
3127 }
3128 ]
3129 },
3130 %{
3131 group: :pleroma,
3132 key: :restrict_unauthenticated,
3133 label: "Restrict Unauthenticated",
3134 type: :group,
3135 description:
3136 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3137 children: [
3138 %{
3139 key: :timelines,
3140 type: :map,
3141 description: "Settings for public and federated timelines.",
3142 children: [
3143 %{
3144 key: :local,
3145 type: :boolean,
3146 description: "Disallow view public timeline."
3147 },
3148 %{
3149 key: :federated,
3150 type: :boolean,
3151 description: "Disallow view federated timeline."
3152 }
3153 ]
3154 },
3155 %{
3156 key: :profiles,
3157 type: :map,
3158 description: "Settings for user profiles.",
3159 children: [
3160 %{
3161 key: :local,
3162 type: :boolean,
3163 description: "Disallow view local user profiles."
3164 },
3165 %{
3166 key: :remote,
3167 type: :boolean,
3168 description: "Disallow view remote user profiles."
3169 }
3170 ]
3171 },
3172 %{
3173 key: :activities,
3174 type: :map,
3175 description: "Settings for statuses.",
3176 children: [
3177 %{
3178 key: :local,
3179 type: :boolean,
3180 description: "Disallow view local statuses."
3181 },
3182 %{
3183 key: :remote,
3184 type: :boolean,
3185 description: "Disallow view remote statuses."
3186 }
3187 ]
3188 }
3189 ]
3190 },
3191 %{
3192 group: :pleroma,
3193 key: Pleroma.Web.ApiSpec.CastAndValidate,
3194 type: :group,
3195 children: [
3196 %{
3197 key: :strict,
3198 type: :boolean,
3199 description:
3200 "Enables strict input validation (useful in development, not recommended in production)"
3201 }
3202 ]
3203 },
3204 %{
3205 group: :pleroma,
3206 key: :instances_favicons,
3207 type: :group,
3208 description: "Control favicons for instances",
3209 children: [
3210 %{
3211 key: :enabled,
3212 type: :boolean,
3213 description: "Allow/disallow displaying and getting instances favicons"
3214 }
3215 ]
3216 },
3217 %{
3218 group: :ex_aws,
3219 key: :s3,
3220 type: :group,
3221 descriptions: "S3 service related settings",
3222 children: [
3223 %{
3224 key: :access_key_id,
3225 type: :string,
3226 description: "S3 access key ID",
3227 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3228 },
3229 %{
3230 key: :secret_access_key,
3231 type: :string,
3232 description: "Secret access key",
3233 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3234 },
3235 %{
3236 key: :host,
3237 type: :string,
3238 description: "S3 host",
3239 suggestions: ["s3.eu-central-1.amazonaws.com"]
3240 },
3241 %{
3242 key: :region,
3243 type: :string,
3244 description: "S3 region (for AWS)",
3245 suggestions: ["us-east-1"]
3246 }
3247 ]
3248 },
3249 %{
3250 group: :pleroma,
3251 key: :frontends,
3252 type: :group,
3253 description: "Installed frontends management",
3254 children: [
3255 %{
3256 key: :primary,
3257 type: :map,
3258 description: "Primary frontend, the one that is served for all pages by default",
3259 children: installed_frontend_options
3260 },
3261 %{
3262 key: :admin,
3263 type: :map,
3264 description: "Admin frontend",
3265 children: installed_frontend_options
3266 },
3267 %{
3268 key: :available,
3269 type: :map,
3270 description:
3271 "A map containing available frontends and parameters for their installation.",
3272 children: frontend_options
3273 }
3274 ]
3275 },
3276 %{
3277 group: :pleroma,
3278 key: Pleroma.Web.Preload,
3279 type: :group,
3280 description: "Preload-related settings",
3281 children: [
3282 %{
3283 key: :providers,
3284 type: {:list, :module},
3285 description: "List of preload providers to enable",
3286 suggestions: [
3287 Pleroma.Web.Preload.Providers.Instance,
3288 Pleroma.Web.Preload.Providers.User,
3289 Pleroma.Web.Preload.Providers.Timelines,
3290 Pleroma.Web.Preload.Providers.StatusNet
3291 ]
3292 }
3293 ]
3294 },
3295 %{
3296 group: :pleroma,
3297 key: :majic_pool,
3298 type: :group,
3299 description: "Majic/libmagic configuration",
3300 children: [
3301 %{
3302 key: :size,
3303 type: :integer,
3304 description: "Number of majic workers to start.",
3305 suggestions: [2]
3306 }
3307 ]
3308 },
3309 %{
3310 group: :pleroma,
3311 key: Pleroma.User.Backup,
3312 type: :group,
3313 description: "Account Backup",
3314 children: [
3315 %{
3316 key: :purge_after_days,
3317 type: :integer,
3318 description: "Remove backup achives after N days",
3319 suggestions: [30]
3320 },
3321 %{
3322 key: :limit_days,
3323 type: :integer,
3324 description: "Limit user to export not more often than once per N days",
3325 suggestions: [7]
3326 }
3327 ]
3328 },
3329 %{
3330 group: :prometheus,
3331 key: Pleroma.Web.Endpoint.MetricsExporter,
3332 type: :group,
3333 description: "Prometheus app metrics endpoint configuration",
3334 children: [
3335 %{
3336 key: :enabled,
3337 type: :boolean,
3338 description: "[Pleroma extension] Enables app metrics endpoint."
3339 },
3340 %{
3341 key: :ip_whitelist,
3342 label: "IP Whitelist",
3343 type: [{:list, :string}, {:list, :charlist}, {:list, :tuple}],
3344 description: "Restrict access of app metrics endpoint to the specified IP addresses."
3345 },
3346 %{
3347 key: :auth,
3348 type: [:boolean, :tuple],
3349 description: "Enables HTTP Basic Auth for app metrics endpoint.",
3350 suggestion: [false, {:basic, "myusername", "mypassword"}]
3351 },
3352 %{
3353 key: :path,
3354 type: :string,
3355 description: "App metrics endpoint URI path.",
3356 suggestions: ["/api/pleroma/app_metrics"]
3357 },
3358 %{
3359 key: :format,
3360 type: :atom,
3361 description: "App metrics endpoint output format.",
3362 suggestions: [:text, :protobuf]
3363 }
3364 ]
3365 },
3366 %{
3367 group: :pleroma,
3368 key: ConcurrentLimiter,
3369 type: :group,
3370 description: "Limits configuration for background tasks.",
3371 children: [
3372 %{
3373 key: Pleroma.Web.RichMedia.Helpers,
3374 type: :keyword,
3375 description: "Concurrent limits configuration for getting RichMedia for activities.",
3376 suggestions: [max_running: 5, max_waiting: 5],
3377 children: [
3378 %{
3379 key: :max_running,
3380 type: :integer,
3381 description: "Max running concurrently jobs.",
3382 suggestion: [5]
3383 },
3384 %{
3385 key: :max_waiting,
3386 type: :integer,
3387 description: "Max waiting jobs.",
3388 suggestion: [5]
3389 }
3390 ]
3391 },
3392 %{
3393 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3394 type: :keyword,
3395 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3396 suggestions: [max_running: 5, max_waiting: 5],
3397 children: [
3398 %{
3399 key: :max_running,
3400 type: :integer,
3401 description: "Max running concurrently jobs.",
3402 suggestion: [5]
3403 },
3404 %{
3405 key: :max_waiting,
3406 type: :integer,
3407 description: "Max waiting jobs.",
3408 suggestion: [5]
3409 }
3410 ]
3411 }
3412 ]
3413 }
3414 ]
Fork of https://akkoma.dev/AkkomaGang/akkoma.git