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