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