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