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