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