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