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