1b2afebef0cc923a4eedd61ab52ffe05d0fb4e0d
[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 activities from (except deletes)",
1321 suggestions: ["example.com", "*.example.com"]
1322 },
1323 %{
1324 key: :accept,
1325 type: {:list, :string},
1326 description: "List of instances to only accept activities from (except deletes)",
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 key: :reject_deletes,
1349 type: {:list, :string},
1350 description: "List of instances to reject deletions from",
1351 suggestions: ["example.com", "*.example.com"]
1352 }
1353 ]
1354 },
1355 %{
1356 group: :pleroma,
1357 key: :mrf_subchain,
1358 label: "MRF subchain",
1359 type: :group,
1360 description:
1361 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1362 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1363 children: [
1364 %{
1365 key: :match_actor,
1366 type: :map,
1367 description: "Matches a series of regular expressions against the actor field",
1368 suggestions: [
1369 %{
1370 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1371 }
1372 ]
1373 }
1374 ]
1375 },
1376 %{
1377 group: :pleroma,
1378 key: :mrf_rejectnonpublic,
1379 description:
1380 "MRF RejectNonPublic settings. RejectNonPublic drops posts with non-public visibility settings.",
1381 label: "MRF reject non public",
1382 type: :group,
1383 children: [
1384 %{
1385 key: :allow_followersonly,
1386 label: "Allow followers-only",
1387 type: :boolean,
1388 description: "Whether to allow followers-only posts"
1389 },
1390 %{
1391 key: :allow_direct,
1392 type: :boolean,
1393 description: "Whether to allow direct messages"
1394 }
1395 ]
1396 },
1397 %{
1398 group: :pleroma,
1399 key: :mrf_hellthread,
1400 label: "MRF hellthread",
1401 type: :group,
1402 description: "Block messages with too much mentions",
1403 children: [
1404 %{
1405 key: :delist_threshold,
1406 type: :integer,
1407 description:
1408 "Number of mentioned users after which the message gets delisted (the message can still be seen, " <>
1409 " but it will not show up in public timelines and mentioned users won't get notifications about it). Set to 0 to disable.",
1410 suggestions: [10]
1411 },
1412 %{
1413 key: :reject_threshold,
1414 type: :integer,
1415 description:
1416 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1417 suggestions: [20]
1418 }
1419 ]
1420 },
1421 %{
1422 group: :pleroma,
1423 key: :mrf_keyword,
1424 label: "MRF keyword",
1425 type: :group,
1426 description: "Reject or Word-Replace messages with a keyword or regex",
1427 children: [
1428 %{
1429 key: :reject,
1430 type: [:string, :regex],
1431 description:
1432 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1433 suggestions: ["foo", ~r/foo/iu]
1434 },
1435 %{
1436 key: :federated_timeline_removal,
1437 type: [:string, :regex],
1438 description:
1439 "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.",
1440 suggestions: ["foo", ~r/foo/iu]
1441 },
1442 %{
1443 key: :replace,
1444 type: [{:tuple, :string, :string}, {:tuple, :regex, :string}],
1445 description:
1446 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1447 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1448 }
1449 ]
1450 },
1451 %{
1452 group: :pleroma,
1453 key: :mrf_mention,
1454 label: "MRF mention",
1455 type: :group,
1456 description: "Block messages which mention a user",
1457 children: [
1458 %{
1459 key: :actors,
1460 type: {:list, :string},
1461 description: "A list of actors for which any post mentioning them will be dropped.",
1462 suggestions: ["actor1", "actor2"]
1463 }
1464 ]
1465 },
1466 %{
1467 group: :pleroma,
1468 key: :mrf_vocabulary,
1469 label: "MRF vocabulary",
1470 type: :group,
1471 description: "Filter messages which belong to certain activity vocabularies",
1472 children: [
1473 %{
1474 key: :accept,
1475 type: {:list, :string},
1476 description:
1477 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted",
1478 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1479 },
1480 %{
1481 key: :reject,
1482 type: {:list, :string},
1483 description:
1484 "A list of ActivityStreams terms to reject. If empty, no messages are rejected",
1485 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1486 }
1487 ]
1488 },
1489 # %{
1490 # group: :pleroma,
1491 # key: :mrf_user_allowlist,
1492 # type: :group,
1493 # description:
1494 # "The keys in this section are the domain names that the policy should apply to." <>
1495 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1496 # children: [
1497 # ["example.org": ["https://example.org/users/admin"]],
1498 # suggestions: [
1499 # ["example.org": ["https://example.org/users/admin"]]
1500 # ]
1501 # ]
1502 # },
1503 %{
1504 group: :pleroma,
1505 key: :media_proxy,
1506 type: :group,
1507 description: "Media proxy",
1508 children: [
1509 %{
1510 key: :enabled,
1511 type: :boolean,
1512 description: "Enables proxying of remote media to the instance's proxy"
1513 },
1514 %{
1515 key: :base_url,
1516 type: :string,
1517 description:
1518 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1519 suggestions: ["https://example.com"]
1520 },
1521 %{
1522 key: :proxy_opts,
1523 type: :keyword,
1524 description: "Options for Pleroma.ReverseProxy",
1525 suggestions: [
1526 redirect_on_failure: false,
1527 max_body_length: 25 * 1_048_576,
1528 http: [
1529 follow_redirect: true,
1530 pool: :media
1531 ]
1532 ],
1533 children: [
1534 %{
1535 key: :redirect_on_failure,
1536 type: :boolean,
1537 description:
1538 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1539 "Any error during body processing will not be redirected as the response is chunked."
1540 },
1541 %{
1542 key: :max_body_length,
1543 type: :integer,
1544 description:
1545 "Limits the content length to be approximately the " <>
1546 "specified length. It is validated with the `content-length` header and also verified when proxying."
1547 },
1548 %{
1549 key: :http,
1550 type: :keyword,
1551 description: "HTTP options",
1552 children: [
1553 %{
1554 key: :adapter,
1555 type: :keyword,
1556 description: "Adapter specific options",
1557 children: [
1558 %{
1559 key: :ssl_options,
1560 type: :keyword,
1561 label: "SSL Options",
1562 description: "SSL options for HTTP adapter",
1563 children: [
1564 %{
1565 key: :versions,
1566 type: {:list, :atom},
1567 description: "List of TLS version to use",
1568 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1569 }
1570 ]
1571 }
1572 ]
1573 },
1574 %{
1575 key: :proxy_url,
1576 label: "Proxy URL",
1577 type: [:string, :tuple],
1578 description: "Proxy URL",
1579 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1580 }
1581 ]
1582 }
1583 ]
1584 },
1585 %{
1586 key: :whitelist,
1587 type: {:list, :string},
1588 description: "List of domains to bypass the mediaproxy",
1589 suggestions: ["example.com"]
1590 }
1591 ]
1592 },
1593 %{
1594 group: :pleroma,
1595 key: :gopher,
1596 type: :group,
1597 description: "Gopher settings",
1598 children: [
1599 %{
1600 key: :enabled,
1601 type: :boolean,
1602 description: "Enables the gopher interface"
1603 },
1604 %{
1605 key: :ip,
1606 type: :tuple,
1607 description: "IP address to bind to",
1608 suggestions: [{0, 0, 0, 0}]
1609 },
1610 %{
1611 key: :port,
1612 type: :integer,
1613 description: "Port to bind to",
1614 suggestions: [9999]
1615 },
1616 %{
1617 key: :dstport,
1618 type: :integer,
1619 description: "Port advertised in urls (optional, defaults to port)",
1620 suggestions: [9999]
1621 }
1622 ]
1623 },
1624 %{
1625 group: :pleroma,
1626 key: :activitypub,
1627 type: :group,
1628 description: "ActivityPub-related settings",
1629 children: [
1630 %{
1631 key: :unfollow_blocked,
1632 type: :boolean,
1633 description: "Whether blocks result in people getting unfollowed"
1634 },
1635 %{
1636 key: :outgoing_blocks,
1637 type: :boolean,
1638 description: "Whether to federate blocks to other instances"
1639 },
1640 %{
1641 key: :sign_object_fetches,
1642 type: :boolean,
1643 description: "Sign object fetches with HTTP signatures"
1644 },
1645 %{
1646 key: :note_replies_output_limit,
1647 type: :integer,
1648 description:
1649 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)."
1650 },
1651 %{
1652 key: :follow_handshake_timeout,
1653 type: :integer,
1654 description: "Following handshake timeout",
1655 suggestions: [500]
1656 }
1657 ]
1658 },
1659 %{
1660 group: :pleroma,
1661 key: :http_security,
1662 type: :group,
1663 description: "HTTP security settings",
1664 children: [
1665 %{
1666 key: :enabled,
1667 type: :boolean,
1668 description: "Whether the managed content security policy is enabled"
1669 },
1670 %{
1671 key: :sts,
1672 label: "STS",
1673 type: :boolean,
1674 description: "Whether to additionally send a Strict-Transport-Security header"
1675 },
1676 %{
1677 key: :sts_max_age,
1678 label: "STS max age",
1679 type: :integer,
1680 description: "The maximum age for the Strict-Transport-Security header if sent",
1681 suggestions: [31_536_000]
1682 },
1683 %{
1684 key: :ct_max_age,
1685 label: "CT max age",
1686 type: :integer,
1687 description: "The maximum age for the Expect-CT header if sent",
1688 suggestions: [2_592_000]
1689 },
1690 %{
1691 key: :referrer_policy,
1692 type: :string,
1693 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1694 suggestions: ["same-origin", "no-referrer"]
1695 },
1696 %{
1697 key: :report_uri,
1698 label: "Report URI",
1699 type: :string,
1700 description: "Adds the specified url to report-uri and report-to group in CSP header",
1701 suggestions: ["https://example.com/report-uri"]
1702 }
1703 ]
1704 },
1705 %{
1706 group: :web_push_encryption,
1707 key: :vapid_details,
1708 type: :group,
1709 description:
1710 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it",
1711 children: [
1712 %{
1713 key: :subject,
1714 type: :string,
1715 description:
1716 "A mailto link for the administrative contact." <>
1717 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1718 suggestions: ["mailto:moderators@pleroma.com"]
1719 },
1720 %{
1721 key: :public_key,
1722 type: :string,
1723 description: "VAPID public key",
1724 suggestions: ["Public key"]
1725 },
1726 %{
1727 key: :private_key,
1728 type: :string,
1729 description: "VAPID private key",
1730 suggestions: ["Private key"]
1731 }
1732 ]
1733 },
1734 %{
1735 group: :pleroma,
1736 key: Pleroma.Captcha,
1737 type: :group,
1738 description: "Captcha-related settings",
1739 children: [
1740 %{
1741 key: :enabled,
1742 type: :boolean,
1743 description: "Whether the captcha should be shown on registration"
1744 },
1745 %{
1746 key: :method,
1747 type: :module,
1748 description: "The method/service to use for captcha",
1749 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1750 },
1751 %{
1752 key: :seconds_valid,
1753 type: :integer,
1754 description: "The time in seconds for which the captcha is valid",
1755 suggestions: [60]
1756 }
1757 ]
1758 },
1759 %{
1760 group: :pleroma,
1761 key: Pleroma.Captcha.Kocaptcha,
1762 type: :group,
1763 description:
1764 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1765 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1766 children: [
1767 %{
1768 key: :endpoint,
1769 type: :string,
1770 description: "The kocaptcha endpoint to use",
1771 suggestions: ["https://captcha.kotobank.ch"]
1772 }
1773 ]
1774 },
1775 %{
1776 group: :pleroma,
1777 type: :group,
1778 description:
1779 "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",
1780 children: [
1781 %{
1782 key: :admin_token,
1783 type: :string,
1784 description: "Token",
1785 suggestions: ["We recommend a secure random string or UUID"]
1786 }
1787 ]
1788 },
1789 %{
1790 group: :pleroma,
1791 key: Oban,
1792 type: :group,
1793 description: """
1794 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
1795
1796 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
1797 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
1798 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
1799 (see https://github.com/sorentwo/oban/issues/52).
1800 """,
1801 children: [
1802 %{
1803 key: :repo,
1804 type: :module,
1805 description: "Application's Ecto repo",
1806 suggestions: [Pleroma.Repo]
1807 },
1808 %{
1809 key: :verbose,
1810 type: {:dropdown, :atom},
1811 description: "Logs verbose mode",
1812 suggestions: [false, :error, :warn, :info, :debug]
1813 },
1814 %{
1815 key: :prune,
1816 type: [:atom, :tuple],
1817 description:
1818 "Non-retryable jobs [pruning settings](https://github.com/sorentwo/oban#pruning)",
1819 suggestions: [:disabled, {:maxlen, 1500}, {:maxage, 60 * 60}]
1820 },
1821 %{
1822 key: :queues,
1823 type: {:keyword, :integer},
1824 description:
1825 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1826 suggestions: [
1827 activity_expiration: 10,
1828 attachments_cleanup: 5,
1829 background: 5,
1830 federator_incoming: 50,
1831 federator_outgoing: 50,
1832 mailer: 10,
1833 scheduled_activities: 10,
1834 transmogrifier: 20,
1835 web_push: 50
1836 ],
1837 children: [
1838 %{
1839 key: :activity_expiration,
1840 type: :integer,
1841 description: "Activity expiration queue",
1842 suggestions: [10]
1843 },
1844 %{
1845 key: :attachments_cleanup,
1846 type: :integer,
1847 description: "Attachment deletion queue",
1848 suggestions: [5]
1849 },
1850 %{
1851 key: :background,
1852 type: :integer,
1853 description: "Background queue",
1854 suggestions: [5]
1855 },
1856 %{
1857 key: :federator_incoming,
1858 type: :integer,
1859 description: "Incoming federation queue",
1860 suggestions: [50]
1861 },
1862 %{
1863 key: :federator_outgoing,
1864 type: :integer,
1865 description: "Outgoing federation queue",
1866 suggestions: [50]
1867 },
1868 %{
1869 key: :mailer,
1870 type: :integer,
1871 description: "Email sender queue, see Pleroma.Emails.Mailer",
1872 suggestions: [10]
1873 },
1874 %{
1875 key: :scheduled_activities,
1876 type: :integer,
1877 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1878 suggestions: [10]
1879 },
1880 %{
1881 key: :transmogrifier,
1882 type: :integer,
1883 description: "Transmogrifier queue",
1884 suggestions: [20]
1885 },
1886 %{
1887 key: :web_push,
1888 type: :integer,
1889 description: "Web push notifications queue",
1890 suggestions: [50]
1891 }
1892 ]
1893 },
1894 %{
1895 key: :crontab,
1896 type: {:list, :tuple},
1897 description: "Settings for cron background jobs",
1898 suggestions: [
1899 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
1900 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
1901 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
1902 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1903 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1904 ]
1905 }
1906 ]
1907 },
1908 %{
1909 group: :pleroma,
1910 key: :workers,
1911 type: :group,
1912 description: "Includes custom worker options not interpretable directly by `Oban`",
1913 children: [
1914 %{
1915 key: :retries,
1916 type: {:keyword, :integer},
1917 description: "Max retry attempts for failed jobs, per `Oban` queue",
1918 suggestions: [
1919 federator_incoming: 5,
1920 federator_outgoing: 5
1921 ]
1922 }
1923 ]
1924 },
1925 %{
1926 group: :pleroma,
1927 key: Pleroma.Web.Metadata,
1928 type: :group,
1929 description: "Metadata-related settings",
1930 children: [
1931 %{
1932 key: :providers,
1933 type: {:list, :module},
1934 description: "List of metadata providers to enable",
1935 suggestions: [
1936 Pleroma.Web.Metadata.Providers.OpenGraph,
1937 Pleroma.Web.Metadata.Providers.TwitterCard,
1938 Pleroma.Web.Metadata.Providers.RelMe,
1939 Pleroma.Web.Metadata.Providers.Feed
1940 ]
1941 },
1942 %{
1943 key: :unfurl_nsfw,
1944 label: "Unfurl NSFW",
1945 type: :boolean,
1946 description: "When enabled NSFW attachments will be shown in previews"
1947 }
1948 ]
1949 },
1950 %{
1951 group: :pleroma,
1952 key: :rich_media,
1953 type: :group,
1954 description:
1955 "If enabled the instance will parse metadata from attached links to generate link previews.",
1956 children: [
1957 %{
1958 key: :enabled,
1959 type: :boolean,
1960 description: "Enables RichMedia parsing of URLs."
1961 },
1962 %{
1963 key: :ignore_hosts,
1964 type: {:list, :string},
1965 description: "List of hosts which will be ignored by the metadata parser.",
1966 suggestions: ["accounts.google.com", "xss.website"]
1967 },
1968 %{
1969 key: :ignore_tld,
1970 label: "Ignore TLD",
1971 type: {:list, :string},
1972 description: "List TLDs (top-level domains) which will ignore for parse metadata.",
1973 suggestions: ["local", "localdomain", "lan"]
1974 },
1975 %{
1976 key: :parsers,
1977 type: {:list, :module},
1978 description: "List of Rich Media parsers.",
1979 suggestions: [
1980 Pleroma.Web.RichMedia.Parsers.MetaTagsParser,
1981 Pleroma.Web.RichMedia.Parsers.OEmbed,
1982 Pleroma.Web.RichMedia.Parsers.OGP,
1983 Pleroma.Web.RichMedia.Parsers.TwitterCard
1984 ]
1985 },
1986 %{
1987 key: :ttl_setters,
1988 label: "TTL setters",
1989 type: {:list, :module},
1990 description: "List of rich media TTL setters.",
1991 suggestions: [
1992 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
1993 ]
1994 }
1995 ]
1996 },
1997 %{
1998 group: :auto_linker,
1999 key: :opts,
2000 type: :group,
2001 description: "Configuration for the auto_linker library",
2002 children: [
2003 %{
2004 key: :class,
2005 type: [:string, false],
2006 description: "Specify the class to be added to the generated link. Disable to clear",
2007 suggestions: ["auto-linker", false]
2008 },
2009 %{
2010 key: :rel,
2011 type: [:string, false],
2012 description: "Override the rel attribute. Disable to clear",
2013 suggestions: ["ugc", "noopener noreferrer", false]
2014 },
2015 %{
2016 key: :new_window,
2017 type: :boolean,
2018 description: "Link urls will open in new window/tab"
2019 },
2020 %{
2021 key: :truncate,
2022 type: [:integer, false],
2023 description:
2024 "Set to a number to truncate urls longer then the number. Truncated urls will end in `..`",
2025 suggestions: [15, false]
2026 },
2027 %{
2028 key: :strip_prefix,
2029 type: :boolean,
2030 description: "Strip the scheme prefix"
2031 },
2032 %{
2033 key: :extra,
2034 type: :boolean,
2035 description: "Link urls with rarely used schemes (magnet, ipfs, irc, etc.)"
2036 }
2037 ]
2038 },
2039 %{
2040 group: :pleroma,
2041 key: Pleroma.ScheduledActivity,
2042 type: :group,
2043 description: "Scheduled activities settings",
2044 children: [
2045 %{
2046 key: :daily_user_limit,
2047 type: :integer,
2048 description:
2049 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2050 suggestions: [25]
2051 },
2052 %{
2053 key: :total_user_limit,
2054 type: :integer,
2055 description:
2056 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2057 suggestions: [300]
2058 },
2059 %{
2060 key: :enabled,
2061 type: :boolean,
2062 description: "Whether scheduled activities are sent to the job queue to be executed"
2063 }
2064 ]
2065 },
2066 %{
2067 group: :pleroma,
2068 key: Pleroma.ActivityExpiration,
2069 type: :group,
2070 description: "Expired activity settings",
2071 children: [
2072 %{
2073 key: :enabled,
2074 type: :boolean,
2075 description: "Whether expired activities will be sent to the job queue to be deleted"
2076 }
2077 ]
2078 },
2079 %{
2080 group: :pleroma,
2081 type: :group,
2082 description: "Authenticator",
2083 children: [
2084 %{
2085 key: Pleroma.Web.Auth.Authenticator,
2086 type: :module,
2087 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2088 }
2089 ]
2090 },
2091 %{
2092 group: :pleroma,
2093 key: :ldap,
2094 type: :group,
2095 description:
2096 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2097 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2098 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2099 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2100 children: [
2101 %{
2102 key: :enabled,
2103 type: :boolean,
2104 description: "Enables LDAP authentication"
2105 },
2106 %{
2107 key: :host,
2108 type: :string,
2109 description: "LDAP server hostname",
2110 suggestions: ["localhosts"]
2111 },
2112 %{
2113 key: :port,
2114 type: :integer,
2115 description: "LDAP port, e.g. 389 or 636",
2116 suggestions: [389, 636]
2117 },
2118 %{
2119 key: :ssl,
2120 label: "SSL",
2121 type: :boolean,
2122 description: "Enable to use SSL, usually implies the port 636"
2123 },
2124 %{
2125 key: :sslopts,
2126 label: "SSL options",
2127 type: :keyword,
2128 description: "Additional SSL options",
2129 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2130 children: [
2131 %{
2132 key: :cacertfile,
2133 type: :string,
2134 description: "Path to file with PEM encoded cacerts",
2135 suggestions: ["path/to/file/with/PEM/cacerts"]
2136 },
2137 %{
2138 key: :verify,
2139 type: :atom,
2140 description: "Type of cert verification",
2141 suggestions: [:verify_peer]
2142 }
2143 ]
2144 },
2145 %{
2146 key: :tls,
2147 label: "TLS",
2148 type: :boolean,
2149 description: "Enable to use STARTTLS, usually implies the port 389"
2150 },
2151 %{
2152 key: :tlsopts,
2153 label: "TLS options",
2154 type: :keyword,
2155 description: "Additional TLS options",
2156 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2157 children: [
2158 %{
2159 key: :cacertfile,
2160 type: :string,
2161 description: "Path to file with PEM encoded cacerts",
2162 suggestions: ["path/to/file/with/PEM/cacerts"]
2163 },
2164 %{
2165 key: :verify,
2166 type: :atom,
2167 description: "Type of cert verification",
2168 suggestions: [:verify_peer]
2169 }
2170 ]
2171 },
2172 %{
2173 key: :base,
2174 type: :string,
2175 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2176 suggestions: ["dc=example,dc=com"]
2177 },
2178 %{
2179 key: :uid,
2180 type: :string,
2181 description:
2182 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2183 suggestions: ["cn"]
2184 }
2185 ]
2186 },
2187 %{
2188 group: :pleroma,
2189 key: :auth,
2190 type: :group,
2191 description: "Authentication / authorization settings",
2192 children: [
2193 %{
2194 key: :enforce_oauth_admin_scope_usage,
2195 type: :boolean,
2196 description:
2197 "OAuth admin scope requirement toggle. " <>
2198 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2199 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s)," <>
2200 "`is_admin` user flag grants access to admin-specific actions."
2201 },
2202 %{
2203 key: :auth_template,
2204 type: :string,
2205 description:
2206 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2207 suggestions: ["show.html"]
2208 },
2209 %{
2210 key: :oauth_consumer_template,
2211 type: :string,
2212 description:
2213 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2214 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2215 suggestions: ["consumer.html"]
2216 },
2217 %{
2218 key: :oauth_consumer_strategies,
2219 type: {:list, :string},
2220 description:
2221 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2222 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2223 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2224 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2225 }
2226 ]
2227 },
2228 %{
2229 group: :pleroma,
2230 key: :email_notifications,
2231 type: :group,
2232 description: "Email notifications settings",
2233 children: [
2234 %{
2235 key: :digest,
2236 type: :map,
2237 description:
2238 "emails of \"what you've missed\" for users who have been inactive for a while",
2239 suggestions: [
2240 %{
2241 active: false,
2242 schedule: "0 0 * * 0",
2243 interval: 7,
2244 inactivity_threshold: 7
2245 }
2246 ],
2247 children: [
2248 %{
2249 key: :active,
2250 label: "Enabled",
2251 type: :boolean,
2252 description: "Globally enable or disable digest emails"
2253 },
2254 %{
2255 key: :schedule,
2256 type: :string,
2257 description:
2258 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2259 suggestions: ["0 0 * * 0"]
2260 },
2261 %{
2262 key: :interval,
2263 type: :integer,
2264 description: "Minimum interval between digest emails to one user",
2265 suggestions: [7]
2266 },
2267 %{
2268 key: :inactivity_threshold,
2269 type: :integer,
2270 description: "Minimum user inactivity threshold",
2271 suggestions: [7]
2272 }
2273 ]
2274 }
2275 ]
2276 },
2277 %{
2278 group: :pleroma,
2279 key: Pleroma.Emails.UserEmail,
2280 type: :group,
2281 description: "Email template settings",
2282 children: [
2283 %{
2284 key: :logo,
2285 type: :string,
2286 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2287 suggestions: ["some/path/logo.png"]
2288 },
2289 %{
2290 key: :styling,
2291 type: :map,
2292 description: "a map with color settings for email templates.",
2293 suggestions: [
2294 %{
2295 link_color: "#d8a070",
2296 background_color: "#2C3645",
2297 content_background_color: "#1B2635",
2298 header_color: "#d8a070",
2299 text_color: "#b9b9ba",
2300 text_muted_color: "#b9b9ba"
2301 }
2302 ],
2303 children: [
2304 %{
2305 key: :link_color,
2306 type: :string,
2307 suggestions: ["#d8a070"]
2308 },
2309 %{
2310 key: :background_color,
2311 type: :string,
2312 suggestions: ["#2C3645"]
2313 },
2314 %{
2315 key: :content_background_color,
2316 type: :string,
2317 suggestions: ["#1B2635"]
2318 },
2319 %{
2320 key: :header_color,
2321 type: :string,
2322 suggestions: ["#d8a070"]
2323 },
2324 %{
2325 key: :text_color,
2326 type: :string,
2327 suggestions: ["#b9b9ba"]
2328 },
2329 %{
2330 key: :text_muted_color,
2331 type: :string,
2332 suggestions: ["#b9b9ba"]
2333 }
2334 ]
2335 }
2336 ]
2337 },
2338 %{
2339 group: :pleroma,
2340 key: Pleroma.Emails.NewUsersDigestEmail,
2341 type: :group,
2342 description: "New users admin email digest",
2343 children: [
2344 %{
2345 key: :enabled,
2346 type: :boolean,
2347 description: "enables new users admin digest email when `true`",
2348 suggestions: [false]
2349 }
2350 ]
2351 },
2352 %{
2353 group: :pleroma,
2354 key: :oauth2,
2355 type: :group,
2356 description: "Configure OAuth 2 provider capabilities",
2357 children: [
2358 %{
2359 key: :token_expires_in,
2360 type: :integer,
2361 description: "The lifetime in seconds of the access token",
2362 suggestions: [600]
2363 },
2364 %{
2365 key: :issue_new_refresh_token,
2366 type: :boolean,
2367 description:
2368 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2369 },
2370 %{
2371 key: :clean_expired_tokens,
2372 type: :boolean,
2373 description: "Enable a background job to clean expired oauth tokens. Default: disabled."
2374 }
2375 ]
2376 },
2377 %{
2378 group: :pleroma,
2379 key: :emoji,
2380 type: :group,
2381 children: [
2382 %{
2383 key: :shortcode_globs,
2384 type: {:list, :string},
2385 description: "Location of custom emoji files. * can be used as a wildcard.",
2386 suggestions: ["/emoji/custom/**/*.png"]
2387 },
2388 %{
2389 key: :pack_extensions,
2390 type: {:list, :string},
2391 description:
2392 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2393 suggestions: [".png", ".gif"]
2394 },
2395 %{
2396 key: :groups,
2397 type: {:keyword, :string, {:list, :string}},
2398 description:
2399 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2400 " and the value is the location or array of locations. * can be used as a wildcard.",
2401 suggestions: [
2402 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2403 ]
2404 },
2405 %{
2406 key: :default_manifest,
2407 type: :string,
2408 description:
2409 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2410 " Currently only one manifest can be added (no arrays).",
2411 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2412 },
2413 %{
2414 key: :shared_pack_cache_seconds_per_file,
2415 label: "Shared pack cache s/file",
2416 type: :integer,
2417 descpiption:
2418 "When an emoji pack is shared, the archive is created and cached in memory" <>
2419 " for this amount of seconds multiplied by the number of files.",
2420 suggestions: [60]
2421 }
2422 ]
2423 },
2424 %{
2425 group: :pleroma,
2426 key: :rate_limit,
2427 type: :group,
2428 description:
2429 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2430 children: [
2431 %{
2432 key: :search,
2433 type: [:tuple, {:list, :tuple}],
2434 description: "For the search requests (account & status search etc.)",
2435 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2436 },
2437 %{
2438 key: :timeline,
2439 type: [:tuple, {:list, :tuple}],
2440 description: "For requests to timelines (each timeline has it's own limiter)",
2441 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2442 },
2443 %{
2444 key: :app_account_creation,
2445 type: [:tuple, {:list, :tuple}],
2446 description: "For registering user accounts from the same IP address",
2447 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2448 },
2449 %{
2450 key: :relations_actions,
2451 type: [:tuple, {:list, :tuple}],
2452 description: "For actions on relationships with all users (follow, unfollow)",
2453 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2454 },
2455 %{
2456 key: :relation_id_action,
2457 type: [:tuple, {:list, :tuple}],
2458 description: "For actions on relation with a specific user (follow, unfollow)",
2459 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2460 },
2461 %{
2462 key: :statuses_actions,
2463 type: [:tuple, {:list, :tuple}],
2464 description:
2465 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2466 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2467 },
2468 %{
2469 key: :status_id_action,
2470 type: [:tuple, {:list, :tuple}],
2471 description:
2472 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2473 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2474 },
2475 %{
2476 key: :authentication,
2477 type: [:tuple, {:list, :tuple}],
2478 description: "For authentication create / password check / user existence check requests",
2479 suggestions: [{60_000, 15}]
2480 }
2481 ]
2482 },
2483 %{
2484 group: :esshd,
2485 type: :group,
2486 description:
2487 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2488 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2489 children: [
2490 %{
2491 key: :enabled,
2492 type: :boolean,
2493 description: "Enables SSH"
2494 },
2495 %{
2496 key: :priv_dir,
2497 type: :string,
2498 description: "Dir with SSH keys",
2499 suggestions: ["/some/path/ssh_keys"]
2500 },
2501 %{
2502 key: :handler,
2503 type: :string,
2504 description: "Handler module",
2505 suggestions: ["Pleroma.BBS.Handler"]
2506 },
2507 %{
2508 key: :port,
2509 type: :integer,
2510 description: "Port to connect",
2511 suggestions: [10_022]
2512 },
2513 %{
2514 key: :password_authenticator,
2515 type: :string,
2516 description: "Authenticator module",
2517 suggestions: ["Pleroma.BBS.Authenticator"]
2518 }
2519 ]
2520 },
2521 %{
2522 group: :mime,
2523 type: :group,
2524 description: "Mime types",
2525 children: [
2526 %{
2527 key: :types,
2528 type: :map,
2529 suggestions: [
2530 %{
2531 "application/xml" => ["xml"],
2532 "application/xrd+xml" => ["xrd+xml"],
2533 "application/jrd+json" => ["jrd+json"],
2534 "application/activity+json" => ["activity+json"],
2535 "application/ld+json" => ["activity+json"]
2536 }
2537 ],
2538 children: [
2539 %{
2540 key: "application/xml",
2541 type: {:list, :string},
2542 suggestions: ["xml"]
2543 },
2544 %{
2545 key: "application/xrd+xml",
2546 type: {:list, :string},
2547 suggestions: ["xrd+xml"]
2548 },
2549 %{
2550 key: "application/jrd+json",
2551 type: {:list, :string},
2552 suggestions: ["jrd+json"]
2553 },
2554 %{
2555 key: "application/activity+json",
2556 type: {:list, :string},
2557 suggestions: ["activity+json"]
2558 },
2559 %{
2560 key: "application/ld+json",
2561 type: {:list, :string},
2562 suggestions: ["activity+json"]
2563 }
2564 ]
2565 }
2566 ]
2567 },
2568 %{
2569 group: :pleroma,
2570 key: :chat,
2571 type: :group,
2572 description: "Pleroma chat settings",
2573 children: [
2574 %{
2575 key: :enabled,
2576 type: :boolean
2577 }
2578 ]
2579 },
2580 %{
2581 group: :http_signatures,
2582 type: :group,
2583 description: "HTTP Signatures settings",
2584 children: [
2585 %{
2586 key: :adapter,
2587 type: :module,
2588 suggestions: [Pleroma.Signature]
2589 }
2590 ]
2591 },
2592 %{
2593 group: :pleroma,
2594 key: :http,
2595 type: :group,
2596 description: "HTTP settings",
2597 children: [
2598 %{
2599 key: :proxy_url,
2600 label: "Proxy URL",
2601 type: [:string, :tuple],
2602 description: "Proxy URL",
2603 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2604 },
2605 %{
2606 key: :send_user_agent,
2607 type: :boolean
2608 },
2609 %{
2610 key: :user_agent,
2611 type: [:string, :atom],
2612 description:
2613 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2614 suggestions: ["Pleroma", :default]
2615 },
2616 %{
2617 key: :adapter,
2618 type: :keyword,
2619 description: "Adapter specific options",
2620 suggestions: [],
2621 children: [
2622 %{
2623 key: :ssl_options,
2624 type: :keyword,
2625 label: "SSL Options",
2626 description: "SSL options for HTTP adapter",
2627 children: [
2628 %{
2629 key: :versions,
2630 type: {:list, :atom},
2631 description: "List of TLS version to use",
2632 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2633 }
2634 ]
2635 }
2636 ]
2637 }
2638 ]
2639 },
2640 %{
2641 group: :pleroma,
2642 key: :markup,
2643 type: :group,
2644 children: [
2645 %{
2646 key: :allow_inline_images,
2647 type: :boolean
2648 },
2649 %{
2650 key: :allow_headings,
2651 type: :boolean
2652 },
2653 %{
2654 key: :allow_tables,
2655 type: :boolean
2656 },
2657 %{
2658 key: :allow_fonts,
2659 type: :boolean
2660 },
2661 %{
2662 key: :scrub_policy,
2663 type: {:list, :module},
2664 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2665 }
2666 ]
2667 },
2668 %{
2669 group: :pleroma,
2670 key: :user,
2671 type: :group,
2672 children: [
2673 %{
2674 key: :deny_follow_blocked,
2675 type: :boolean
2676 }
2677 ]
2678 },
2679 %{
2680 group: :pleroma,
2681 key: :mrf_normalize_markup,
2682 label: "MRF normalize markup",
2683 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
2684 type: :group,
2685 children: [
2686 %{
2687 key: :scrub_policy,
2688 type: :module,
2689 suggestions: [Pleroma.HTML.Scrubber.Default]
2690 }
2691 ]
2692 },
2693 %{
2694 group: :pleroma,
2695 key: Pleroma.User,
2696 type: :group,
2697 children: [
2698 %{
2699 key: :restricted_nicknames,
2700 type: {:list, :string},
2701 suggestions: [
2702 ".well-known",
2703 "~",
2704 "about",
2705 "activities",
2706 "api",
2707 "auth",
2708 "check_password",
2709 "dev",
2710 "friend-requests",
2711 "inbox",
2712 "internal",
2713 "main",
2714 "media",
2715 "nodeinfo",
2716 "notice",
2717 "oauth",
2718 "objects",
2719 "ostatus_subscribe",
2720 "pleroma",
2721 "proxy",
2722 "push",
2723 "registration",
2724 "relay",
2725 "settings",
2726 "status",
2727 "tag",
2728 "user-search",
2729 "user_exists",
2730 "users",
2731 "web"
2732 ]
2733 }
2734 ]
2735 },
2736 %{
2737 group: :cors_plug,
2738 type: :group,
2739 children: [
2740 %{
2741 key: :max_age,
2742 type: :integer,
2743 suggestions: [86_400]
2744 },
2745 %{
2746 key: :methods,
2747 type: {:list, :string},
2748 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2749 },
2750 %{
2751 key: :expose,
2752 type: {:list, :string},
2753 suggestions: [
2754 "Link",
2755 "X-RateLimit-Reset",
2756 "X-RateLimit-Limit",
2757 "X-RateLimit-Remaining",
2758 "X-Request-Id",
2759 "Idempotency-Key"
2760 ]
2761 },
2762 %{
2763 key: :credentials,
2764 type: :boolean
2765 },
2766 %{
2767 key: :headers,
2768 type: {:list, :string},
2769 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2770 }
2771 ]
2772 },
2773 %{
2774 group: :pleroma,
2775 key: Pleroma.Plugs.RemoteIp,
2776 type: :group,
2777 description: """
2778 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2779 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2780 """,
2781 children: [
2782 %{
2783 key: :enabled,
2784 type: :boolean,
2785 description: "Enable/disable the plug. Default: disabled."
2786 },
2787 %{
2788 key: :headers,
2789 type: {:list, :string},
2790 description:
2791 "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]`."
2792 },
2793 %{
2794 key: :proxies,
2795 type: {:list, :string},
2796 description:
2797 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
2798 },
2799 %{
2800 key: :reserved,
2801 type: {:list, :string},
2802 description:
2803 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
2804 }
2805 ]
2806 },
2807 %{
2808 group: :pleroma,
2809 key: :web_cache_ttl,
2810 type: :group,
2811 description:
2812 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2813 children: [
2814 %{
2815 key: :activity_pub,
2816 type: :integer,
2817 description:
2818 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2819 suggestions: [30_000, nil]
2820 },
2821 %{
2822 key: :activity_pub_question,
2823 type: :integer,
2824 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2825 suggestions: [30_000]
2826 }
2827 ]
2828 },
2829 %{
2830 group: :pleroma,
2831 key: :static_fe,
2832 type: :group,
2833 description:
2834 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript.",
2835 children: [
2836 %{
2837 key: :enabled,
2838 type: :boolean,
2839 description: "Enables the rendering of static HTML. Default: disabled."
2840 }
2841 ]
2842 },
2843 %{
2844 group: :pleroma,
2845 key: :feed,
2846 type: :group,
2847 description: "Configure feed rendering",
2848 children: [
2849 %{
2850 key: :post_title,
2851 type: :map,
2852 description: "Configure title rendering.",
2853 children: [
2854 %{
2855 key: :max_length,
2856 type: :integer,
2857 description: "Maximum number of characters before truncating title.",
2858 suggestions: [100]
2859 },
2860 %{
2861 key: :omission,
2862 type: :string,
2863 description: "Replacement which will be used after truncating string.",
2864 suggestions: ["..."]
2865 }
2866 ]
2867 }
2868 ]
2869 },
2870 %{
2871 group: :pleroma,
2872 key: :mrf_object_age,
2873 type: :group,
2874 description: "Rejects or delists posts based on their age when received.",
2875 children: [
2876 %{
2877 key: :threshold,
2878 type: :integer,
2879 description: "Required age (in seconds) of a post before actions are taken.",
2880 suggestions: [172_800]
2881 },
2882 %{
2883 key: :actions,
2884 type: {:list, :atom},
2885 description:
2886 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
2887 "`:strip_followers` removes followers from the ActivityPub recipient list, ensuring they won't be delivered to home timelines; " <>
2888 "`:reject` rejects the message entirely",
2889 suggestions: [:delist, :strip_followers, :reject]
2890 }
2891 ]
2892 },
2893 %{
2894 group: :pleroma,
2895 key: :modules,
2896 type: :group,
2897 description: "Custom Runtime Modules",
2898 children: [
2899 %{
2900 key: :runtime_dir,
2901 type: :string,
2902 description: "A path to custom Elixir modules (such as MRF policies)."
2903 }
2904 ]
2905 },
2906 %{
2907 group: :pleroma,
2908 key: :streamer,
2909 type: :group,
2910 description: "Settings for notifications streamer",
2911 children: [
2912 %{
2913 key: :workers,
2914 type: :integer,
2915 description: "Number of workers to send notifications.",
2916 suggestions: [3]
2917 },
2918 %{
2919 key: :overflow_workers,
2920 type: :integer,
2921 description: "Maximum number of workers created if pool is empty.",
2922 suggestions: [2]
2923 }
2924 ]
2925 },
2926 %{
2927 group: :pleroma,
2928 key: :connections_pool,
2929 type: :group,
2930 description: "Advanced settings for `gun` connections pool",
2931 children: [
2932 %{
2933 key: :checkin_timeout,
2934 type: :integer,
2935 description: "Timeout to checkin connection from pool. Default: 250ms.",
2936 suggestions: [250]
2937 },
2938 %{
2939 key: :max_connections,
2940 type: :integer,
2941 description: "Maximum number of connections in the pool. Default: 250 connections.",
2942 suggestions: [250]
2943 },
2944 %{
2945 key: :retry,
2946 type: :integer,
2947 description:
2948 "Number of retries, while `gun` will try to reconnect if connection goes down. Default: 1.",
2949 suggestions: [1]
2950 },
2951 %{
2952 key: :retry_timeout,
2953 type: :integer,
2954 description:
2955 "Time between retries when `gun` will try to reconnect in milliseconds. Default: 1000ms.",
2956 suggestions: [1000]
2957 },
2958 %{
2959 key: :await_up_timeout,
2960 type: :integer,
2961 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
2962 suggestions: [5000]
2963 }
2964 ]
2965 },
2966 %{
2967 group: :pleroma,
2968 key: :pools,
2969 type: :group,
2970 description: "Advanced settings for `gun` workers pools",
2971 children: [
2972 %{
2973 key: :federation,
2974 type: :keyword,
2975 description: "Settings for federation pool.",
2976 children: [
2977 %{
2978 key: :size,
2979 type: :integer,
2980 description: "Number workers in the pool.",
2981 suggestions: [50]
2982 },
2983 %{
2984 key: :max_overflow,
2985 type: :integer,
2986 description: "Number of additional workers if pool is under load.",
2987 suggestions: [10]
2988 },
2989 %{
2990 key: :timeout,
2991 type: :integer,
2992 description: "Timeout while `gun` will wait for response.",
2993 suggestions: [150_000]
2994 }
2995 ]
2996 },
2997 %{
2998 key: :media,
2999 type: :keyword,
3000 description: "Settings for media pool.",
3001 children: [
3002 %{
3003 key: :size,
3004 type: :integer,
3005 description: "Number workers in the pool.",
3006 suggestions: [50]
3007 },
3008 %{
3009 key: :max_overflow,
3010 type: :integer,
3011 description: "Number of additional workers if pool is under load.",
3012 suggestions: [10]
3013 },
3014 %{
3015 key: :timeout,
3016 type: :integer,
3017 description: "Timeout while `gun` will wait for response.",
3018 suggestions: [150_000]
3019 }
3020 ]
3021 },
3022 %{
3023 key: :upload,
3024 type: :keyword,
3025 description: "Settings for upload pool.",
3026 children: [
3027 %{
3028 key: :size,
3029 type: :integer,
3030 description: "Number workers in the pool.",
3031 suggestions: [25]
3032 },
3033 %{
3034 key: :max_overflow,
3035 type: :integer,
3036 description: "Number of additional workers if pool is under load.",
3037 suggestions: [5]
3038 },
3039 %{
3040 key: :timeout,
3041 type: :integer,
3042 description: "Timeout while `gun` will wait for response.",
3043 suggestions: [300_000]
3044 }
3045 ]
3046 },
3047 %{
3048 key: :default,
3049 type: :keyword,
3050 description: "Settings for default pool.",
3051 children: [
3052 %{
3053 key: :size,
3054 type: :integer,
3055 description: "Number workers in the pool.",
3056 suggestions: [10]
3057 },
3058 %{
3059 key: :max_overflow,
3060 type: :integer,
3061 description: "Number of additional workers if pool is under load.",
3062 suggestions: [2]
3063 },
3064 %{
3065 key: :timeout,
3066 type: :integer,
3067 description: "Timeout while `gun` will wait for response.",
3068 suggestions: [10_000]
3069 }
3070 ]
3071 }
3072 ]
3073 },
3074 %{
3075 group: :pleroma,
3076 key: :hackney_pools,
3077 type: :group,
3078 description: "Advanced settings for `hackney` connections pools",
3079 children: [
3080 %{
3081 key: :federation,
3082 type: :keyword,
3083 description: "Settings for federation pool.",
3084 children: [
3085 %{
3086 key: :max_connections,
3087 type: :integer,
3088 description: "Number workers in the pool.",
3089 suggestions: [50]
3090 },
3091 %{
3092 key: :timeout,
3093 type: :integer,
3094 description: "Timeout while `hackney` will wait for response.",
3095 suggestions: [150_000]
3096 }
3097 ]
3098 },
3099 %{
3100 key: :media,
3101 type: :keyword,
3102 description: "Settings for media pool.",
3103 children: [
3104 %{
3105 key: :max_connections,
3106 type: :integer,
3107 description: "Number workers in the pool.",
3108 suggestions: [50]
3109 },
3110 %{
3111 key: :timeout,
3112 type: :integer,
3113 description: "Timeout while `hackney` will wait for response.",
3114 suggestions: [150_000]
3115 }
3116 ]
3117 },
3118 %{
3119 key: :upload,
3120 type: :keyword,
3121 description: "Settings for upload pool.",
3122 children: [
3123 %{
3124 key: :max_connections,
3125 type: :integer,
3126 description: "Number workers in the pool.",
3127 suggestions: [25]
3128 },
3129 %{
3130 key: :timeout,
3131 type: :integer,
3132 description: "Timeout while `hackney` will wait for response.",
3133 suggestions: [300_000]
3134 }
3135 ]
3136 }
3137 ]
3138 },
3139 %{
3140 group: :pleroma,
3141 key: :restrict_unauthenticated,
3142 type: :group,
3143 description:
3144 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3145 children: [
3146 %{
3147 key: :timelines,
3148 type: :map,
3149 description: "Settings for public and federated timelines.",
3150 children: [
3151 %{
3152 key: :local,
3153 type: :boolean,
3154 description: "Disallow view public timeline."
3155 },
3156 %{
3157 key: :federated,
3158 type: :boolean,
3159 description: "Disallow view federated timeline."
3160 }
3161 ]
3162 },
3163 %{
3164 key: :profiles,
3165 type: :map,
3166 description: "Settings for user profiles.",
3167 children: [
3168 %{
3169 key: :local,
3170 type: :boolean,
3171 description: "Disallow view local user profiles."
3172 },
3173 %{
3174 key: :remote,
3175 type: :boolean,
3176 description: "Disallow view remote user profiles."
3177 }
3178 ]
3179 },
3180 %{
3181 key: :activities,
3182 type: :map,
3183 description: "Settings for statuses.",
3184 children: [
3185 %{
3186 key: :local,
3187 type: :boolean,
3188 description: "Disallow view local statuses."
3189 },
3190 %{
3191 key: :remote,
3192 type: :boolean,
3193 description: "Disallow view remote statuses."
3194 }
3195 ]
3196 }
3197 ]
3198 },
3199 %{
3200 group: :pleroma,
3201 key: Pleroma.Web.ApiSpec.CastAndValidate,
3202 type: :group,
3203 children: [
3204 %{
3205 key: :strict,
3206 type: :boolean,
3207 description:
3208 "Enables strict input validation (useful in development, not recommended in production)",
3209 suggestions: [false]
3210 }
3211 ]
3212 }
3213 ]