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