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