868b89d296b5217b6d9a691aa882232fe9e80016
[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_subchain,
1675 tab: :mrf,
1676 related_policy: "Pleroma.Web.ActivityPub.MRF.SubchainPolicy",
1677 label: "MRF Subchain",
1678 type: :group,
1679 description:
1680 "This policy processes messages through an alternate pipeline when a given message matches certain criteria." <>
1681 " All criteria are configured as a map of regular expressions to lists of policy modules.",
1682 children: [
1683 %{
1684 key: :match_actor,
1685 type: {:map, {:list, :string}},
1686 description: "Matches a series of regular expressions against the actor field",
1687 suggestions: [
1688 %{
1689 ~r/https:\/\/example.com/s => [Pleroma.Web.ActivityPub.MRF.DropPolicy]
1690 }
1691 ]
1692 }
1693 ]
1694 },
1695 %{
1696 group: :pleroma,
1697 key: :mrf_rejectnonpublic,
1698 tab: :mrf,
1699 related_policy: "Pleroma.Web.ActivityPub.MRF.RejectNonPublic",
1700 description: "RejectNonPublic drops posts with non-public visibility settings.",
1701 label: "MRF Reject Non Public",
1702 type: :group,
1703 children: [
1704 %{
1705 key: :allow_followersonly,
1706 label: "Allow followers-only",
1707 type: :boolean,
1708 description: "Whether to allow followers-only posts"
1709 },
1710 %{
1711 key: :allow_direct,
1712 type: :boolean,
1713 description: "Whether to allow direct messages"
1714 }
1715 ]
1716 },
1717 %{
1718 group: :pleroma,
1719 key: :mrf_hellthread,
1720 tab: :mrf,
1721 related_policy: "Pleroma.Web.ActivityPub.MRF.HellthreadPolicy",
1722 label: "MRF Hellthread",
1723 type: :group,
1724 description: "Block messages with excessive user mentions",
1725 children: [
1726 %{
1727 key: :delist_threshold,
1728 type: :integer,
1729 description:
1730 "Number of mentioned users after which the message gets removed from timelines and" <>
1731 "disables notifications. Set to 0 to disable.",
1732 suggestions: [10]
1733 },
1734 %{
1735 key: :reject_threshold,
1736 type: :integer,
1737 description:
1738 "Number of mentioned users after which the messaged gets rejected. Set to 0 to disable.",
1739 suggestions: [20]
1740 }
1741 ]
1742 },
1743 %{
1744 group: :pleroma,
1745 key: :mrf_keyword,
1746 tab: :mrf,
1747 related_policy: "Pleroma.Web.ActivityPub.MRF.KeywordPolicy",
1748 label: "MRF Keyword",
1749 type: :group,
1750 description: "Reject or Word-Replace messages with a keyword or regex",
1751 children: [
1752 %{
1753 key: :reject,
1754 type: {:list, :string},
1755 description:
1756 "A list of patterns which result in message being rejected. Each pattern can be a string or a regular expression.",
1757 suggestions: ["foo", ~r/foo/iu]
1758 },
1759 %{
1760 key: :federated_timeline_removal,
1761 type: {:list, :string},
1762 description:
1763 "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.",
1764 suggestions: ["foo", ~r/foo/iu]
1765 },
1766 %{
1767 key: :replace,
1768 type: {:list, :tuple},
1769 description:
1770 "A list of tuples containing {pattern, replacement}. Each pattern can be a string or a regular expression.",
1771 suggestions: [{"foo", "bar"}, {~r/foo/iu, "bar"}]
1772 }
1773 ]
1774 },
1775 %{
1776 group: :pleroma,
1777 key: :mrf_mention,
1778 tab: :mrf,
1779 related_policy: "Pleroma.Web.ActivityPub.MRF.MentionPolicy",
1780 label: "MRF Mention",
1781 type: :group,
1782 description: "Block messages which mention a specific user",
1783 children: [
1784 %{
1785 key: :actors,
1786 type: {:list, :string},
1787 description: "A list of actors for which any post mentioning them will be dropped",
1788 suggestions: ["actor1", "actor2"]
1789 }
1790 ]
1791 },
1792 %{
1793 group: :pleroma,
1794 key: :mrf_vocabulary,
1795 tab: :mrf,
1796 related_policy: "Pleroma.Web.ActivityPub.MRF.VocabularyPolicy",
1797 label: "MRF Vocabulary",
1798 type: :group,
1799 description: "Filter messages which belong to certain activity vocabularies",
1800 children: [
1801 %{
1802 key: :accept,
1803 type: {:list, :string},
1804 description:
1805 "A list of ActivityStreams terms to accept. If empty, all supported messages are accepted.",
1806 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1807 },
1808 %{
1809 key: :reject,
1810 type: {:list, :string},
1811 description:
1812 "A list of ActivityStreams terms to reject. If empty, no messages are rejected.",
1813 suggestions: ["Create", "Follow", "Mention", "Announce", "Like"]
1814 }
1815 ]
1816 },
1817 # %{
1818 # group: :pleroma,
1819 # key: :mrf_user_allowlist,
1820 # tab: :mrf,
1821 # related_policy: "Pleroma.Web.ActivityPub.MRF.UserAllowListPolicy",
1822 # type: :map,
1823 # description:
1824 # "The keys in this section are the domain names that the policy should apply to." <>
1825 # " Each key should be assigned a list of users that should be allowed through by their ActivityPub ID",
1826 # suggestions: [
1827 # %{"example.org" => ["https://example.org/users/admin"]}
1828 # ]
1829 # ]
1830 # },
1831 %{
1832 group: :pleroma,
1833 key: :media_proxy,
1834 type: :group,
1835 description: "Media proxy",
1836 children: [
1837 %{
1838 key: :enabled,
1839 type: :boolean,
1840 description: "Enables proxying of remote media to the instance's proxy"
1841 },
1842 %{
1843 key: :base_url,
1844 label: "Base URL",
1845 type: :string,
1846 description:
1847 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1848 suggestions: ["https://example.com"]
1849 },
1850 %{
1851 key: :invalidation,
1852 type: :keyword,
1853 descpiption: "",
1854 suggestions: [
1855 enabled: true,
1856 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1857 ],
1858 children: [
1859 %{
1860 key: :enabled,
1861 type: :boolean,
1862 description: "Enables media cache object invalidation."
1863 },
1864 %{
1865 key: :provider,
1866 type: :module,
1867 description: "Module which will be used to purge objects from the cache.",
1868 suggestions: [
1869 Pleroma.Web.MediaProxy.Invalidation.Script,
1870 Pleroma.Web.MediaProxy.Invalidation.Http
1871 ]
1872 }
1873 ]
1874 },
1875 %{
1876 key: :proxy_opts,
1877 label: "Proxy Options",
1878 type: :keyword,
1879 description: "Options for Pleroma.ReverseProxy",
1880 suggestions: [
1881 redirect_on_failure: false,
1882 max_body_length: 25 * 1_048_576,
1883 max_read_duration: 30_000,
1884 http: [
1885 follow_redirect: true,
1886 pool: :media
1887 ]
1888 ],
1889 children: [
1890 %{
1891 key: :redirect_on_failure,
1892 type: :boolean,
1893 description:
1894 "Redirects the client to the real remote URL if there's any HTTP errors. " <>
1895 "Any error during body processing will not be redirected as the response is chunked."
1896 },
1897 %{
1898 key: :max_body_length,
1899 type: :integer,
1900 description:
1901 "Limits the content length to be approximately the " <>
1902 "specified length. It is validated with the `content-length` header and also verified when proxying."
1903 },
1904 %{
1905 key: :max_read_duration,
1906 type: :integer,
1907 description: "Timeout (in milliseconds) of GET request to remote URI."
1908 },
1909 %{
1910 key: :http,
1911 label: "HTTP",
1912 type: :keyword,
1913 description: "HTTP options",
1914 children: [
1915 %{
1916 key: :adapter,
1917 type: :keyword,
1918 description: "Adapter specific options",
1919 children: [
1920 %{
1921 key: :ssl_options,
1922 type: :keyword,
1923 label: "SSL Options",
1924 description: "SSL options for HTTP adapter",
1925 children: [
1926 %{
1927 key: :versions,
1928 type: {:list, :atom},
1929 description: "List of TLS version to use",
1930 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
1931 }
1932 ]
1933 }
1934 ]
1935 },
1936 %{
1937 key: :proxy_url,
1938 label: "Proxy URL",
1939 type: [:string, :tuple],
1940 description: "Proxy URL",
1941 suggestions: ["127.0.0.1:8123", {:socks5, :localhost, 9050}]
1942 }
1943 ]
1944 }
1945 ]
1946 },
1947 %{
1948 key: :whitelist,
1949 type: {:list, :string},
1950 description: "List of hosts with scheme to bypass the mediaproxy",
1951 suggestions: ["http://example.com"]
1952 }
1953 ]
1954 },
1955 %{
1956 group: :pleroma,
1957 key: :media_preview_proxy,
1958 type: :group,
1959 description: "Media preview proxy",
1960 children: [
1961 %{
1962 key: :enabled,
1963 type: :boolean,
1964 description:
1965 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1966 },
1967 %{
1968 key: :thumbnail_max_width,
1969 type: :integer,
1970 description: "Max width of preview thumbnail."
1971 },
1972 %{
1973 key: :thumbnail_max_height,
1974 type: :integer,
1975 description: "Max height of preview thumbnail."
1976 },
1977 %{
1978 key: :image_quality,
1979 type: :integer,
1980 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1981 },
1982 %{
1983 key: :proxy_opts,
1984 type: :keyword,
1985 description: "Media proxy options",
1986 suggestions: [
1987 head_request_max_read_duration: 5_000
1988 ],
1989 children: [
1990 %{
1991 key: :head_request_max_read_duration,
1992 type: :integer,
1993 description: "Timeout (in milliseconds) of HEAD request to remote URI."
1994 }
1995 ]
1996 },
1997 %{
1998 key: :whitelist,
1999 type: {:list, :string},
2000 description: "List of hosts with scheme to bypass the mediaproxy",
2001 suggestions: ["http://example.com"]
2002 }
2003 ]
2004 },
2005 %{
2006 group: :pleroma,
2007 key: Pleroma.Web.MediaProxy.Invalidation.Http,
2008 type: :group,
2009 description: "HTTP invalidate settings",
2010 children: [
2011 %{
2012 key: :method,
2013 type: :atom,
2014 description: "HTTP method of request. Default: :purge"
2015 },
2016 %{
2017 key: :headers,
2018 type: {:keyword, :string},
2019 description: "HTTP headers of request",
2020 suggestions: [{"x-refresh", 1}]
2021 },
2022 %{
2023 key: :options,
2024 type: :keyword,
2025 description: "Request options",
2026 children: [
2027 %{
2028 key: :params,
2029 type: {:map, :string}
2030 }
2031 ]
2032 }
2033 ]
2034 },
2035 %{
2036 group: :pleroma,
2037 key: Pleroma.Web.MediaProxy.Invalidation.Script,
2038 type: :group,
2039 description: "Script invalidate settings",
2040 children: [
2041 %{
2042 key: :script_path,
2043 type: :string,
2044 description: "Path to shell script. Which will run purge cache.",
2045 suggestions: ["./installation/nginx-cache-purge.sh.example"]
2046 }
2047 ]
2048 },
2049 %{
2050 group: :pleroma,
2051 key: :gopher,
2052 type: :group,
2053 description: "Gopher settings",
2054 children: [
2055 %{
2056 key: :enabled,
2057 type: :boolean,
2058 description: "Enables the gopher interface"
2059 },
2060 %{
2061 key: :ip,
2062 label: "IP",
2063 type: :tuple,
2064 description: "IP address to bind to",
2065 suggestions: [{0, 0, 0, 0}]
2066 },
2067 %{
2068 key: :port,
2069 type: :integer,
2070 description: "Port to bind to",
2071 suggestions: [9999]
2072 },
2073 %{
2074 key: :dstport,
2075 type: :integer,
2076 description: "Port advertised in URLs (optional, defaults to port)",
2077 suggestions: [9999]
2078 }
2079 ]
2080 },
2081 %{
2082 group: :pleroma,
2083 key: :activitypub,
2084 label: "ActivityPub",
2085 type: :group,
2086 description: "ActivityPub-related settings",
2087 children: [
2088 %{
2089 key: :unfollow_blocked,
2090 type: :boolean,
2091 description: "Whether blocks result in people getting unfollowed"
2092 },
2093 %{
2094 key: :outgoing_blocks,
2095 type: :boolean,
2096 description: "Whether to federate blocks to other instances"
2097 },
2098 %{
2099 key: :sign_object_fetches,
2100 type: :boolean,
2101 description: "Sign object fetches with HTTP signatures"
2102 },
2103 %{
2104 key: :note_replies_output_limit,
2105 type: :integer,
2106 description:
2107 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
2108 },
2109 %{
2110 key: :follow_handshake_timeout,
2111 type: :integer,
2112 description: "Following handshake timeout",
2113 suggestions: [500]
2114 }
2115 ]
2116 },
2117 %{
2118 group: :pleroma,
2119 key: :http_security,
2120 label: "HTTP security",
2121 type: :group,
2122 description: "HTTP security settings",
2123 children: [
2124 %{
2125 key: :enabled,
2126 type: :boolean,
2127 description: "Whether the managed content security policy is enabled"
2128 },
2129 %{
2130 key: :sts,
2131 label: "STS",
2132 type: :boolean,
2133 description: "Whether to additionally send a Strict-Transport-Security header"
2134 },
2135 %{
2136 key: :sts_max_age,
2137 label: "STS max age",
2138 type: :integer,
2139 description: "The maximum age for the Strict-Transport-Security header if sent",
2140 suggestions: [31_536_000]
2141 },
2142 %{
2143 key: :ct_max_age,
2144 label: "CT max age",
2145 type: :integer,
2146 description: "The maximum age for the Expect-CT header if sent",
2147 suggestions: [2_592_000]
2148 },
2149 %{
2150 key: :referrer_policy,
2151 type: :string,
2152 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
2153 suggestions: ["same-origin", "no-referrer"]
2154 },
2155 %{
2156 key: :report_uri,
2157 label: "Report URI",
2158 type: :string,
2159 description: "Adds the specified URL to report-uri and report-to group in CSP header",
2160 suggestions: ["https://example.com/report-uri"]
2161 }
2162 ]
2163 },
2164 %{
2165 group: :web_push_encryption,
2166 key: :vapid_details,
2167 label: "Vapid Details",
2168 type: :group,
2169 description:
2170 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
2171 children: [
2172 %{
2173 key: :subject,
2174 type: :string,
2175 description:
2176 "A mailto link for the administrative contact." <>
2177 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
2178 suggestions: ["mailto:moderators@pleroma.com"]
2179 },
2180 %{
2181 key: :public_key,
2182 type: :string,
2183 description: "VAPID public key",
2184 suggestions: ["Public key"]
2185 },
2186 %{
2187 key: :private_key,
2188 type: :string,
2189 description: "VAPID private key",
2190 suggestions: ["Private key"]
2191 }
2192 ]
2193 },
2194 %{
2195 group: :pleroma,
2196 key: Pleroma.Captcha,
2197 type: :group,
2198 description: "Captcha-related settings",
2199 children: [
2200 %{
2201 key: :enabled,
2202 type: :boolean,
2203 description: "Whether the captcha should be shown on registration"
2204 },
2205 %{
2206 key: :method,
2207 type: :module,
2208 description: "The method/service to use for captcha",
2209 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
2210 },
2211 %{
2212 key: :seconds_valid,
2213 type: :integer,
2214 description: "The time in seconds for which the captcha is valid",
2215 suggestions: [60]
2216 }
2217 ]
2218 },
2219 %{
2220 group: :pleroma,
2221 key: Pleroma.Captcha.Kocaptcha,
2222 type: :group,
2223 description:
2224 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
2225 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
2226 children: [
2227 %{
2228 key: :endpoint,
2229 type: :string,
2230 description: "The kocaptcha endpoint to use",
2231 suggestions: ["https://captcha.kotobank.ch"]
2232 }
2233 ]
2234 },
2235 %{
2236 group: :pleroma,
2237 label: "Pleroma Admin Token",
2238 type: :group,
2239 description:
2240 "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)",
2241 children: [
2242 %{
2243 key: :admin_token,
2244 type: :string,
2245 description: "Admin token",
2246 suggestions: [
2247 "Please use a high entropy string or UUID"
2248 ]
2249 }
2250 ]
2251 },
2252 %{
2253 group: :pleroma,
2254 key: Oban,
2255 type: :group,
2256 description: """
2257 [Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.
2258
2259 Note: if you are running PostgreSQL in [`silent_mode`](https://postgresqlco.nf/en/doc/param/silent_mode?version=9.1),
2260 it's advised to set [`log_destination`](https://postgresqlco.nf/en/doc/param/log_destination?version=9.1) to `syslog`,
2261 otherwise `postmaster.log` file may grow because of "you don't own a lock of type ShareLock" warnings
2262 (see https://github.com/sorentwo/oban/issues/52).
2263 """,
2264 children: [
2265 %{
2266 key: :log,
2267 type: {:dropdown, :atom},
2268 description: "Logs verbose mode",
2269 suggestions: [false, :error, :warn, :info, :debug]
2270 },
2271 %{
2272 key: :queues,
2273 type: {:keyword, :integer},
2274 description:
2275 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
2276 suggestions: [
2277 activity_expiration: 10,
2278 attachments_cleanup: 5,
2279 background: 5,
2280 federator_incoming: 50,
2281 federator_outgoing: 50,
2282 mailer: 10,
2283 scheduled_activities: 10,
2284 transmogrifier: 20,
2285 web_push: 50
2286 ],
2287 children: [
2288 %{
2289 key: :activity_expiration,
2290 type: :integer,
2291 description: "Activity expiration queue",
2292 suggestions: [10]
2293 },
2294 %{
2295 key: :attachments_cleanup,
2296 type: :integer,
2297 description: "Attachment deletion queue",
2298 suggestions: [5]
2299 },
2300 %{
2301 key: :background,
2302 type: :integer,
2303 description: "Background queue",
2304 suggestions: [5]
2305 },
2306 %{
2307 key: :federator_incoming,
2308 type: :integer,
2309 description: "Incoming federation queue",
2310 suggestions: [50]
2311 },
2312 %{
2313 key: :federator_outgoing,
2314 type: :integer,
2315 description: "Outgoing federation queue",
2316 suggestions: [50]
2317 },
2318 %{
2319 key: :mailer,
2320 type: :integer,
2321 description: "Email sender queue, see Pleroma.Emails.Mailer",
2322 suggestions: [10]
2323 },
2324 %{
2325 key: :scheduled_activities,
2326 type: :integer,
2327 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
2328 suggestions: [10]
2329 },
2330 %{
2331 key: :transmogrifier,
2332 type: :integer,
2333 description: "Transmogrifier queue",
2334 suggestions: [20]
2335 },
2336 %{
2337 key: :web_push,
2338 type: :integer,
2339 description: "Web push notifications queue",
2340 suggestions: [50]
2341 }
2342 ]
2343 },
2344 %{
2345 key: :crontab,
2346 type: {:list, :tuple},
2347 description: "Settings for cron background jobs",
2348 suggestions: [
2349 {"0 0 * * *", Pleroma.Workers.Cron.ClearOauthTokenWorker},
2350 {"0 * * * *", Pleroma.Workers.Cron.StatsWorker},
2351 {"* * * * *", Pleroma.Workers.Cron.PurgeExpiredActivitiesWorker},
2352 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
2353 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
2354 ]
2355 }
2356 ]
2357 },
2358 %{
2359 group: :pleroma,
2360 key: :workers,
2361 type: :group,
2362 description: "Includes custom worker options not interpretable directly by `Oban`",
2363 children: [
2364 %{
2365 key: :retries,
2366 type: {:keyword, :integer},
2367 description: "Max retry attempts for failed jobs, per `Oban` queue",
2368 suggestions: [
2369 federator_incoming: 5,
2370 federator_outgoing: 5
2371 ]
2372 }
2373 ]
2374 },
2375 %{
2376 group: :pleroma,
2377 key: Pleroma.Web.Metadata,
2378 type: :group,
2379 description: "Metadata-related settings",
2380 children: [
2381 %{
2382 key: :providers,
2383 type: {:list, :module},
2384 description: "List of metadata providers to enable",
2385 suggestions: [
2386 Pleroma.Web.Metadata.Providers.OpenGraph,
2387 Pleroma.Web.Metadata.Providers.TwitterCard,
2388 Pleroma.Web.Metadata.Providers.RelMe,
2389 Pleroma.Web.Metadata.Providers.Feed
2390 ]
2391 },
2392 %{
2393 key: :unfurl_nsfw,
2394 label: "Unfurl NSFW",
2395 type: :boolean,
2396 description: "When enabled NSFW attachments will be shown in previews"
2397 }
2398 ]
2399 },
2400 %{
2401 group: :pleroma,
2402 key: :rich_media,
2403 type: :group,
2404 description:
2405 "If enabled the instance will parse metadata from attached links to generate link previews",
2406 children: [
2407 %{
2408 key: :enabled,
2409 type: :boolean,
2410 description: "Enables RichMedia parsing of URLs"
2411 },
2412 %{
2413 key: :ignore_hosts,
2414 type: {:list, :string},
2415 description: "List of hosts which will be ignored by the metadata parser",
2416 suggestions: ["accounts.google.com", "xss.website"]
2417 },
2418 %{
2419 key: :ignore_tld,
2420 label: "Ignore TLD",
2421 type: {:list, :string},
2422 description: "List TLDs (top-level domains) which will ignore for parse metadata",
2423 suggestions: ["local", "localdomain", "lan"]
2424 },
2425 %{
2426 key: :parsers,
2427 type: {:list, :module},
2428 description:
2429 "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.",
2430 suggestions: [
2431 Pleroma.Web.RichMedia.Parsers.OEmbed,
2432 Pleroma.Web.RichMedia.Parsers.TwitterCard
2433 ]
2434 },
2435 %{
2436 key: :ttl_setters,
2437 label: "TTL setters",
2438 type: {:list, :module},
2439 description:
2440 "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.",
2441 suggestions: [
2442 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2443 ]
2444 },
2445 %{
2446 key: :failure_backoff,
2447 type: :integer,
2448 description:
2449 "Amount of milliseconds after request failure, during which the request will not be retried.",
2450 suggestions: [60_000]
2451 }
2452 ]
2453 },
2454 %{
2455 group: :pleroma,
2456 key: Pleroma.Formatter,
2457 label: "Auto Linker",
2458 type: :group,
2459 description:
2460 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2461 children: [
2462 %{
2463 key: :class,
2464 type: [:string, :boolean],
2465 description: "Specify the class to be added to the generated link. Disable to clear.",
2466 suggestions: ["auto-linker", false]
2467 },
2468 %{
2469 key: :rel,
2470 type: [:string, :boolean],
2471 description: "Override the rel attribute. Disable to clear.",
2472 suggestions: ["ugc", "noopener noreferrer", false]
2473 },
2474 %{
2475 key: :new_window,
2476 type: :boolean,
2477 description: "Link URLs will open in a new window/tab."
2478 },
2479 %{
2480 key: :truncate,
2481 type: [:integer, :boolean],
2482 description:
2483 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2484 suggestions: [15, false]
2485 },
2486 %{
2487 key: :strip_prefix,
2488 type: :boolean,
2489 description: "Strip the scheme prefix."
2490 },
2491 %{
2492 key: :extra,
2493 type: :boolean,
2494 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2495 },
2496 %{
2497 key: :validate_tld,
2498 type: [:atom, :boolean],
2499 description:
2500 "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)",
2501 suggestions: [:no_scheme, true]
2502 }
2503 ]
2504 },
2505 %{
2506 group: :pleroma,
2507 key: Pleroma.ScheduledActivity,
2508 type: :group,
2509 description: "Scheduled activities settings",
2510 children: [
2511 %{
2512 key: :daily_user_limit,
2513 type: :integer,
2514 description:
2515 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2516 suggestions: [25]
2517 },
2518 %{
2519 key: :total_user_limit,
2520 type: :integer,
2521 description:
2522 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2523 suggestions: [300]
2524 },
2525 %{
2526 key: :enabled,
2527 type: :boolean,
2528 description: "Whether scheduled activities are sent to the job queue to be executed"
2529 }
2530 ]
2531 },
2532 %{
2533 group: :pleroma,
2534 key: Pleroma.ActivityExpiration,
2535 type: :group,
2536 description: "Expired activity settings",
2537 children: [
2538 %{
2539 key: :enabled,
2540 type: :boolean,
2541 description: "Whether expired activities will be sent to the job queue to be deleted"
2542 }
2543 ]
2544 },
2545 %{
2546 group: :pleroma,
2547 label: "Pleroma Authenticator",
2548 type: :group,
2549 description: "Authenticator",
2550 children: [
2551 %{
2552 key: Pleroma.Web.Auth.Authenticator,
2553 type: :module,
2554 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2555 }
2556 ]
2557 },
2558 %{
2559 group: :pleroma,
2560 key: :ldap,
2561 label: "LDAP",
2562 type: :group,
2563 description:
2564 "Use LDAP for user authentication. When a user logs in to the Pleroma instance, the name and password" <>
2565 " will be verified by trying to authenticate (bind) to a LDAP server." <>
2566 " If a user exists in the LDAP directory but there is no account with the same name yet on the" <>
2567 " Pleroma instance then a new Pleroma account will be created with the same name as the LDAP user name.",
2568 children: [
2569 %{
2570 key: :enabled,
2571 type: :boolean,
2572 description: "Enables LDAP authentication"
2573 },
2574 %{
2575 key: :host,
2576 type: :string,
2577 description: "LDAP server hostname",
2578 suggestions: ["localhosts"]
2579 },
2580 %{
2581 key: :port,
2582 type: :integer,
2583 description: "LDAP port, e.g. 389 or 636",
2584 suggestions: [389, 636]
2585 },
2586 %{
2587 key: :ssl,
2588 label: "SSL",
2589 type: :boolean,
2590 description: "Enable to use SSL, usually implies the port 636"
2591 },
2592 %{
2593 key: :sslopts,
2594 label: "SSL options",
2595 type: :keyword,
2596 description: "Additional SSL options",
2597 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2598 children: [
2599 %{
2600 key: :cacertfile,
2601 type: :string,
2602 description: "Path to file with PEM encoded cacerts",
2603 suggestions: ["path/to/file/with/PEM/cacerts"]
2604 },
2605 %{
2606 key: :verify,
2607 type: :atom,
2608 description: "Type of cert verification",
2609 suggestions: [:verify_peer]
2610 }
2611 ]
2612 },
2613 %{
2614 key: :tls,
2615 label: "TLS",
2616 type: :boolean,
2617 description: "Enable to use STARTTLS, usually implies the port 389"
2618 },
2619 %{
2620 key: :tlsopts,
2621 label: "TLS options",
2622 type: :keyword,
2623 description: "Additional TLS options",
2624 suggestions: [cacertfile: "path/to/file/with/PEM/cacerts", verify: :verify_peer],
2625 children: [
2626 %{
2627 key: :cacertfile,
2628 type: :string,
2629 description: "Path to file with PEM encoded cacerts",
2630 suggestions: ["path/to/file/with/PEM/cacerts"]
2631 },
2632 %{
2633 key: :verify,
2634 type: :atom,
2635 description: "Type of cert verification",
2636 suggestions: [:verify_peer]
2637 }
2638 ]
2639 },
2640 %{
2641 key: :base,
2642 type: :string,
2643 description: "LDAP base, e.g. \"dc=example,dc=com\"",
2644 suggestions: ["dc=example,dc=com"]
2645 },
2646 %{
2647 key: :uid,
2648 label: "UID",
2649 type: :string,
2650 description:
2651 "LDAP attribute name to authenticate the user, e.g. when \"cn\", the filter will be \"cn=username,base\"",
2652 suggestions: ["cn"]
2653 }
2654 ]
2655 },
2656 %{
2657 group: :pleroma,
2658 key: :auth,
2659 type: :group,
2660 description: "Authentication / authorization settings",
2661 children: [
2662 %{
2663 key: :enforce_oauth_admin_scope_usage,
2664 label: "Enforce OAuth admin scope usage",
2665 type: :boolean,
2666 description:
2667 "OAuth admin scope requirement toggle. " <>
2668 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2669 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2670 "`is_admin` user flag grants access to admin-specific actions."
2671 },
2672 %{
2673 key: :auth_template,
2674 type: :string,
2675 description:
2676 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2677 suggestions: ["show.html"]
2678 },
2679 %{
2680 key: :oauth_consumer_template,
2681 label: "OAuth consumer template",
2682 type: :string,
2683 description:
2684 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2685 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2686 suggestions: ["consumer.html"]
2687 },
2688 %{
2689 key: :oauth_consumer_strategies,
2690 label: "OAuth consumer strategies",
2691 type: {:list, :string},
2692 description:
2693 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2694 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2695 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2696 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2697 }
2698 ]
2699 },
2700 %{
2701 group: :pleroma,
2702 key: :email_notifications,
2703 type: :group,
2704 description: "Email notifications settings",
2705 children: [
2706 %{
2707 key: :digest,
2708 type: :map,
2709 description:
2710 "emails of \"what you've missed\" for users who have been inactive for a while",
2711 suggestions: [
2712 %{
2713 active: false,
2714 schedule: "0 0 * * 0",
2715 interval: 7,
2716 inactivity_threshold: 7
2717 }
2718 ],
2719 children: [
2720 %{
2721 key: :active,
2722 label: "Enabled",
2723 type: :boolean,
2724 description: "Globally enable or disable digest emails"
2725 },
2726 %{
2727 key: :schedule,
2728 type: :string,
2729 description:
2730 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2731 suggestions: ["0 0 * * 0"]
2732 },
2733 %{
2734 key: :interval,
2735 type: :integer,
2736 description: "Minimum interval between digest emails to one user",
2737 suggestions: [7]
2738 },
2739 %{
2740 key: :inactivity_threshold,
2741 type: :integer,
2742 description: "Minimum user inactivity threshold",
2743 suggestions: [7]
2744 }
2745 ]
2746 }
2747 ]
2748 },
2749 %{
2750 group: :pleroma,
2751 key: Pleroma.Emails.UserEmail,
2752 type: :group,
2753 description: "Email template settings",
2754 children: [
2755 %{
2756 key: :logo,
2757 type: {:string, :image},
2758 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2759 suggestions: ["some/path/logo.png"]
2760 },
2761 %{
2762 key: :styling,
2763 type: :map,
2764 description: "A map with color settings for email templates.",
2765 suggestions: [
2766 %{
2767 link_color: "#d8a070",
2768 background_color: "#2C3645",
2769 content_background_color: "#1B2635",
2770 header_color: "#d8a070",
2771 text_color: "#b9b9ba",
2772 text_muted_color: "#b9b9ba"
2773 }
2774 ],
2775 children: [
2776 %{
2777 key: :link_color,
2778 type: :string,
2779 suggestions: ["#d8a070"]
2780 },
2781 %{
2782 key: :background_color,
2783 type: :string,
2784 suggestions: ["#2C3645"]
2785 },
2786 %{
2787 key: :content_background_color,
2788 type: :string,
2789 suggestions: ["#1B2635"]
2790 },
2791 %{
2792 key: :header_color,
2793 type: :string,
2794 suggestions: ["#d8a070"]
2795 },
2796 %{
2797 key: :text_color,
2798 type: :string,
2799 suggestions: ["#b9b9ba"]
2800 },
2801 %{
2802 key: :text_muted_color,
2803 type: :string,
2804 suggestions: ["#b9b9ba"]
2805 }
2806 ]
2807 }
2808 ]
2809 },
2810 %{
2811 group: :pleroma,
2812 key: Pleroma.Emails.NewUsersDigestEmail,
2813 type: :group,
2814 description: "New users admin email digest",
2815 children: [
2816 %{
2817 key: :enabled,
2818 type: :boolean,
2819 description: "Enables new users admin digest email when `true`"
2820 }
2821 ]
2822 },
2823 %{
2824 group: :pleroma,
2825 key: :oauth2,
2826 label: "OAuth2",
2827 type: :group,
2828 description: "Configure OAuth 2 provider capabilities",
2829 children: [
2830 %{
2831 key: :token_expires_in,
2832 type: :integer,
2833 description: "The lifetime in seconds of the access token",
2834 suggestions: [600]
2835 },
2836 %{
2837 key: :issue_new_refresh_token,
2838 type: :boolean,
2839 description:
2840 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2841 },
2842 %{
2843 key: :clean_expired_tokens,
2844 type: :boolean,
2845 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2846 }
2847 ]
2848 },
2849 %{
2850 group: :pleroma,
2851 key: :emoji,
2852 type: :group,
2853 children: [
2854 %{
2855 key: :shortcode_globs,
2856 type: {:list, :string},
2857 description: "Location of custom emoji files. * can be used as a wildcard.",
2858 suggestions: ["/emoji/custom/**/*.png"]
2859 },
2860 %{
2861 key: :pack_extensions,
2862 type: {:list, :string},
2863 description:
2864 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2865 suggestions: [".png", ".gif"]
2866 },
2867 %{
2868 key: :groups,
2869 type: {:keyword, {:list, :string}},
2870 description:
2871 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2872 " and the value is the location or array of locations. * can be used as a wildcard.",
2873 suggestions: [
2874 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2875 ]
2876 },
2877 %{
2878 key: :default_manifest,
2879 type: :string,
2880 description:
2881 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2882 " Currently only one manifest can be added (no arrays).",
2883 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2884 },
2885 %{
2886 key: :shared_pack_cache_seconds_per_file,
2887 label: "Shared pack cache s/file",
2888 type: :integer,
2889 descpiption:
2890 "When an emoji pack is shared, the archive is created and cached in memory" <>
2891 " for this amount of seconds multiplied by the number of files.",
2892 suggestions: [60]
2893 }
2894 ]
2895 },
2896 %{
2897 group: :pleroma,
2898 key: :rate_limit,
2899 type: :group,
2900 description:
2901 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2902 children: [
2903 %{
2904 key: :search,
2905 type: [:tuple, {:list, :tuple}],
2906 description: "For the search requests (account & status search etc.)",
2907 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2908 },
2909 %{
2910 key: :timeline,
2911 type: [:tuple, {:list, :tuple}],
2912 description: "For requests to timelines (each timeline has it's own limiter)",
2913 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2914 },
2915 %{
2916 key: :app_account_creation,
2917 type: [:tuple, {:list, :tuple}],
2918 description: "For registering user accounts from the same IP address",
2919 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2920 },
2921 %{
2922 key: :relations_actions,
2923 type: [:tuple, {:list, :tuple}],
2924 description: "For actions on relationships with all users (follow, unfollow)",
2925 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2926 },
2927 %{
2928 key: :relation_id_action,
2929 label: "Relation ID action",
2930 type: [:tuple, {:list, :tuple}],
2931 description: "For actions on relation with a specific user (follow, unfollow)",
2932 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2933 },
2934 %{
2935 key: :statuses_actions,
2936 type: [:tuple, {:list, :tuple}],
2937 description:
2938 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2939 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2940 },
2941 %{
2942 key: :status_id_action,
2943 label: "Status ID action",
2944 type: [:tuple, {:list, :tuple}],
2945 description:
2946 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2947 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2948 },
2949 %{
2950 key: :authentication,
2951 type: [:tuple, {:list, :tuple}],
2952 description: "For authentication create / password check / user existence check requests",
2953 suggestions: [{60_000, 15}]
2954 }
2955 ]
2956 },
2957 %{
2958 group: :esshd,
2959 label: "ESSHD",
2960 type: :group,
2961 description:
2962 "Before enabling this you must add :esshd to mix.exs as one of the extra_applications " <>
2963 "and generate host keys in your priv dir with ssh-keygen -m PEM -N \"\" -b 2048 -t rsa -f ssh_host_rsa_key",
2964 children: [
2965 %{
2966 key: :enabled,
2967 type: :boolean,
2968 description: "Enables SSH"
2969 },
2970 %{
2971 key: :priv_dir,
2972 type: :string,
2973 description: "Dir with SSH keys",
2974 suggestions: ["/some/path/ssh_keys"]
2975 },
2976 %{
2977 key: :handler,
2978 type: :string,
2979 description: "Handler module",
2980 suggestions: ["Pleroma.BBS.Handler"]
2981 },
2982 %{
2983 key: :port,
2984 type: :integer,
2985 description: "Port to connect",
2986 suggestions: [10_022]
2987 },
2988 %{
2989 key: :password_authenticator,
2990 type: :string,
2991 description: "Authenticator module",
2992 suggestions: ["Pleroma.BBS.Authenticator"]
2993 }
2994 ]
2995 },
2996 %{
2997 group: :mime,
2998 label: "Mime Types",
2999 type: :group,
3000 description: "Mime Types settings",
3001 children: [
3002 %{
3003 key: :types,
3004 type: :map,
3005 suggestions: [
3006 %{
3007 "application/xml" => ["xml"],
3008 "application/xrd+xml" => ["xrd+xml"],
3009 "application/jrd+json" => ["jrd+json"],
3010 "application/activity+json" => ["activity+json"],
3011 "application/ld+json" => ["activity+json"]
3012 }
3013 ],
3014 children: [
3015 %{
3016 key: "application/xml",
3017 type: {:list, :string},
3018 suggestions: ["xml"]
3019 },
3020 %{
3021 key: "application/xrd+xml",
3022 type: {:list, :string},
3023 suggestions: ["xrd+xml"]
3024 },
3025 %{
3026 key: "application/jrd+json",
3027 type: {:list, :string},
3028 suggestions: ["jrd+json"]
3029 },
3030 %{
3031 key: "application/activity+json",
3032 type: {:list, :string},
3033 suggestions: ["activity+json"]
3034 },
3035 %{
3036 key: "application/ld+json",
3037 type: {:list, :string},
3038 suggestions: ["activity+json"]
3039 }
3040 ]
3041 }
3042 ]
3043 },
3044 %{
3045 group: :pleroma,
3046 key: :chat,
3047 type: :group,
3048 description: "Pleroma chat settings",
3049 children: [
3050 %{
3051 key: :enabled,
3052 type: :boolean
3053 }
3054 ]
3055 },
3056 %{
3057 group: :pleroma,
3058 key: :http,
3059 label: "HTTP",
3060 type: :group,
3061 description: "HTTP settings",
3062 children: [
3063 %{
3064 key: :proxy_url,
3065 label: "Proxy URL",
3066 type: [:string, :tuple],
3067 description: "Proxy URL",
3068 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
3069 },
3070 %{
3071 key: :send_user_agent,
3072 type: :boolean
3073 },
3074 %{
3075 key: :user_agent,
3076 type: [:string, :atom],
3077 description:
3078 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
3079 suggestions: ["Pleroma", :default]
3080 },
3081 %{
3082 key: :adapter,
3083 type: :keyword,
3084 description: "Adapter specific options",
3085 suggestions: [],
3086 children: [
3087 %{
3088 key: :ssl_options,
3089 type: :keyword,
3090 label: "SSL Options",
3091 description: "SSL options for HTTP adapter",
3092 children: [
3093 %{
3094 key: :versions,
3095 type: {:list, :atom},
3096 description: "List of TLS version to use",
3097 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
3098 }
3099 ]
3100 }
3101 ]
3102 }
3103 ]
3104 },
3105 %{
3106 group: :pleroma,
3107 key: :markup,
3108 label: "Markup Settings",
3109 type: :group,
3110 children: [
3111 %{
3112 key: :allow_inline_images,
3113 type: :boolean
3114 },
3115 %{
3116 key: :allow_headings,
3117 type: :boolean
3118 },
3119 %{
3120 key: :allow_tables,
3121 type: :boolean
3122 },
3123 %{
3124 key: :allow_fonts,
3125 type: :boolean
3126 },
3127 %{
3128 key: :scrub_policy,
3129 type: {:list, :module},
3130 description:
3131 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
3132 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
3133 }
3134 ]
3135 },
3136 %{
3137 group: :pleroma,
3138 key: :user,
3139 type: :group,
3140 children: [
3141 %{
3142 key: :deny_follow_blocked,
3143 type: :boolean
3144 }
3145 ]
3146 },
3147 %{
3148 group: :pleroma,
3149 key: :mrf_normalize_markup,
3150 tab: :mrf,
3151 related_policy: "Pleroma.Web.ActivityPub.MRF.NormalizeMarkup",
3152 label: "MRF Normalize Markup",
3153 description: "MRF NormalizeMarkup settings. Scrub configured hypertext markup.",
3154 type: :group,
3155 children: [
3156 %{
3157 key: :scrub_policy,
3158 type: :module,
3159 suggestions: [Pleroma.HTML.Scrubber.Default]
3160 }
3161 ]
3162 },
3163 %{
3164 group: :pleroma,
3165 key: Pleroma.User,
3166 type: :group,
3167 children: [
3168 %{
3169 key: :restricted_nicknames,
3170 type: {:list, :string},
3171 description: "List of nicknames users may not register with.",
3172 suggestions: [
3173 ".well-known",
3174 "~",
3175 "about",
3176 "activities",
3177 "api",
3178 "auth",
3179 "check_password",
3180 "dev",
3181 "friend-requests",
3182 "inbox",
3183 "internal",
3184 "main",
3185 "media",
3186 "nodeinfo",
3187 "notice",
3188 "oauth",
3189 "objects",
3190 "ostatus_subscribe",
3191 "pleroma",
3192 "proxy",
3193 "push",
3194 "registration",
3195 "relay",
3196 "settings",
3197 "status",
3198 "tag",
3199 "user-search",
3200 "user_exists",
3201 "users",
3202 "web"
3203 ]
3204 },
3205 %{
3206 key: :email_blacklist,
3207 type: {:list, :string},
3208 description: "List of email domains users may not register with.",
3209 suggestions: ["mailinator.com", "maildrop.cc"]
3210 }
3211 ]
3212 },
3213 %{
3214 group: :cors_plug,
3215 label: "CORS plug config",
3216 type: :group,
3217 children: [
3218 %{
3219 key: :max_age,
3220 type: :integer,
3221 suggestions: [86_400]
3222 },
3223 %{
3224 key: :methods,
3225 type: {:list, :string},
3226 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
3227 },
3228 %{
3229 key: :expose,
3230 type: {:list, :string},
3231 suggestions: [
3232 "Link",
3233 "X-RateLimit-Reset",
3234 "X-RateLimit-Limit",
3235 "X-RateLimit-Remaining",
3236 "X-Request-Id",
3237 "Idempotency-Key"
3238 ]
3239 },
3240 %{
3241 key: :credentials,
3242 type: :boolean
3243 },
3244 %{
3245 key: :headers,
3246 type: {:list, :string},
3247 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
3248 }
3249 ]
3250 },
3251 %{
3252 group: :pleroma,
3253 key: Pleroma.Plugs.RemoteIp,
3254 type: :group,
3255 description: """
3256 `Pleroma.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
3257 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
3258 """,
3259 children: [
3260 %{
3261 key: :enabled,
3262 type: :boolean,
3263 description: "Enable/disable the plug. Default: disabled."
3264 },
3265 %{
3266 key: :headers,
3267 type: {:list, :string},
3268 description:
3269 "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]`."
3270 },
3271 %{
3272 key: :proxies,
3273 type: {:list, :string},
3274 description:
3275 "A list of strings in [CIDR](https://en.wikipedia.org/wiki/CIDR) notation specifying the IPs of known proxies. Default: `[]`."
3276 },
3277 %{
3278 key: :reserved,
3279 type: {:list, :string},
3280 description:
3281 "Defaults to [localhost](https://en.wikipedia.org/wiki/Localhost) and [private network](https://en.wikipedia.org/wiki/Private_network)."
3282 }
3283 ]
3284 },
3285 %{
3286 group: :pleroma,
3287 key: :web_cache_ttl,
3288 label: "Web cache TTL",
3289 type: :group,
3290 description:
3291 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
3292 children: [
3293 %{
3294 key: :activity_pub,
3295 type: :integer,
3296 description:
3297 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
3298 suggestions: [30_000, nil]
3299 },
3300 %{
3301 key: :activity_pub_question,
3302 type: :integer,
3303 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
3304 suggestions: [30_000]
3305 }
3306 ]
3307 },
3308 %{
3309 group: :pleroma,
3310 key: :static_fe,
3311 label: "Static FE",
3312 type: :group,
3313 description:
3314 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
3315 children: [
3316 %{
3317 key: :enabled,
3318 type: :boolean,
3319 description: "Enables the rendering of static HTML. Default: disabled."
3320 }
3321 ]
3322 },
3323 %{
3324 group: :pleroma,
3325 key: :feed,
3326 type: :group,
3327 description: "Configure feed rendering",
3328 children: [
3329 %{
3330 key: :post_title,
3331 type: :map,
3332 description: "Configure title rendering",
3333 children: [
3334 %{
3335 key: :max_length,
3336 type: :integer,
3337 description: "Maximum number of characters before truncating title",
3338 suggestions: [100]
3339 },
3340 %{
3341 key: :omission,
3342 type: :string,
3343 description: "Replacement which will be used after truncating string",
3344 suggestions: ["..."]
3345 }
3346 ]
3347 }
3348 ]
3349 },
3350 %{
3351 group: :pleroma,
3352 key: :mrf_object_age,
3353 tab: :mrf,
3354 related_policy: "Pleroma.Web.ActivityPub.MRF.ObjectAgePolicy",
3355 label: "MRF Object Age",
3356 type: :group,
3357 description:
3358 "Rejects or delists posts based on their timestamp deviance from your server's clock.",
3359 children: [
3360 %{
3361 key: :threshold,
3362 type: :integer,
3363 description: "Required age (in seconds) of a post before actions are taken.",
3364 suggestions: [172_800]
3365 },
3366 %{
3367 key: :actions,
3368 type: {:list, :atom},
3369 description:
3370 "A list of actions to apply to the post. `:delist` removes the post from public timelines; " <>
3371 "`:strip_followers` removes followers from the ActivityPub recipient list ensuring they won't be delivered to home timelines; " <>
3372 "`:reject` rejects the message entirely",
3373 suggestions: [:delist, :strip_followers, :reject]
3374 }
3375 ]
3376 },
3377 %{
3378 group: :pleroma,
3379 key: :modules,
3380 type: :group,
3381 description: "Custom Runtime Modules",
3382 children: [
3383 %{
3384 key: :runtime_dir,
3385 type: :string,
3386 description: "A path to custom Elixir modules (such as MRF policies)."
3387 }
3388 ]
3389 },
3390 %{
3391 group: :pleroma,
3392 key: :streamer,
3393 type: :group,
3394 description: "Settings for notifications streamer",
3395 children: [
3396 %{
3397 key: :workers,
3398 type: :integer,
3399 description: "Number of workers to send notifications",
3400 suggestions: [3]
3401 },
3402 %{
3403 key: :overflow_workers,
3404 type: :integer,
3405 description: "Maximum number of workers created if pool is empty",
3406 suggestions: [2]
3407 }
3408 ]
3409 },
3410 %{
3411 group: :pleroma,
3412 key: :connections_pool,
3413 type: :group,
3414 description: "Advanced settings for `Gun` connections pool",
3415 children: [
3416 %{
3417 key: :connection_acquisition_wait,
3418 type: :integer,
3419 description:
3420 "Timeout to acquire a connection from pool. The total max time is this value multiplied by the number of retries. Default: 250ms.",
3421 suggestions: [250]
3422 },
3423 %{
3424 key: :connection_acquisition_retries,
3425 type: :integer,
3426 description:
3427 "Number of attempts to acquire the connection from the pool if it is overloaded. Default: 5",
3428 suggestions: [5]
3429 },
3430 %{
3431 key: :max_connections,
3432 type: :integer,
3433 description: "Maximum number of connections in the pool. Default: 250 connections.",
3434 suggestions: [250]
3435 },
3436 %{
3437 key: :await_up_timeout,
3438 type: :integer,
3439 description: "Timeout while `gun` will wait until connection is up. Default: 5000ms.",
3440 suggestions: [5000]
3441 },
3442 %{
3443 key: :reclaim_multiplier,
3444 type: :integer,
3445 description:
3446 "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",
3447 suggestions: [0.1]
3448 }
3449 ]
3450 },
3451 %{
3452 group: :pleroma,
3453 key: :pools,
3454 type: :group,
3455 description: "Advanced settings for `Gun` workers pools",
3456 children:
3457 Enum.map([:federation, :media, :upload, :default], fn pool_name ->
3458 %{
3459 key: pool_name,
3460 type: :keyword,
3461 description: "Settings for #{pool_name} pool.",
3462 children: [
3463 %{
3464 key: :size,
3465 type: :integer,
3466 description: "Maximum number of concurrent requests in the pool.",
3467 suggestions: [50]
3468 },
3469 %{
3470 key: :max_waiting,
3471 type: :integer,
3472 description:
3473 "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",
3474 suggestions: [10]
3475 }
3476 ]
3477 }
3478 end)
3479 },
3480 %{
3481 group: :pleroma,
3482 key: :hackney_pools,
3483 type: :group,
3484 description: "Advanced settings for `Hackney` connections pools",
3485 children: [
3486 %{
3487 key: :federation,
3488 type: :keyword,
3489 description: "Settings for federation pool.",
3490 children: [
3491 %{
3492 key: :max_connections,
3493 type: :integer,
3494 description: "Number workers in the pool.",
3495 suggestions: [50]
3496 },
3497 %{
3498 key: :timeout,
3499 type: :integer,
3500 description: "Timeout while `hackney` will wait for response.",
3501 suggestions: [150_000]
3502 }
3503 ]
3504 },
3505 %{
3506 key: :media,
3507 type: :keyword,
3508 description: "Settings for media pool.",
3509 children: [
3510 %{
3511 key: :max_connections,
3512 type: :integer,
3513 description: "Number workers in the pool.",
3514 suggestions: [50]
3515 },
3516 %{
3517 key: :timeout,
3518 type: :integer,
3519 description: "Timeout while `hackney` will wait for response.",
3520 suggestions: [150_000]
3521 }
3522 ]
3523 },
3524 %{
3525 key: :upload,
3526 type: :keyword,
3527 description: "Settings for upload pool.",
3528 children: [
3529 %{
3530 key: :max_connections,
3531 type: :integer,
3532 description: "Number workers in the pool.",
3533 suggestions: [25]
3534 },
3535 %{
3536 key: :timeout,
3537 type: :integer,
3538 description: "Timeout while `hackney` will wait for response.",
3539 suggestions: [300_000]
3540 }
3541 ]
3542 }
3543 ]
3544 },
3545 %{
3546 group: :pleroma,
3547 key: :restrict_unauthenticated,
3548 label: "Restrict Unauthenticated",
3549 type: :group,
3550 description:
3551 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
3552 children: [
3553 %{
3554 key: :timelines,
3555 type: :map,
3556 description: "Settings for public and federated timelines.",
3557 children: [
3558 %{
3559 key: :local,
3560 type: :boolean,
3561 description: "Disallow view public timeline."
3562 },
3563 %{
3564 key: :federated,
3565 type: :boolean,
3566 description: "Disallow view federated timeline."
3567 }
3568 ]
3569 },
3570 %{
3571 key: :profiles,
3572 type: :map,
3573 description: "Settings for user profiles.",
3574 children: [
3575 %{
3576 key: :local,
3577 type: :boolean,
3578 description: "Disallow view local user profiles."
3579 },
3580 %{
3581 key: :remote,
3582 type: :boolean,
3583 description: "Disallow view remote user profiles."
3584 }
3585 ]
3586 },
3587 %{
3588 key: :activities,
3589 type: :map,
3590 description: "Settings for statuses.",
3591 children: [
3592 %{
3593 key: :local,
3594 type: :boolean,
3595 description: "Disallow view local statuses."
3596 },
3597 %{
3598 key: :remote,
3599 type: :boolean,
3600 description: "Disallow view remote statuses."
3601 }
3602 ]
3603 }
3604 ]
3605 },
3606 %{
3607 group: :pleroma,
3608 key: Pleroma.Web.ApiSpec.CastAndValidate,
3609 type: :group,
3610 children: [
3611 %{
3612 key: :strict,
3613 type: :boolean,
3614 description:
3615 "Enables strict input validation (useful in development, not recommended in production)"
3616 }
3617 ]
3618 },
3619 %{
3620 group: :pleroma,
3621 key: :instances_favicons,
3622 type: :group,
3623 description: "Control favicons for instances",
3624 children: [
3625 %{
3626 key: :enabled,
3627 type: :boolean,
3628 description: "Allow/disallow displaying and getting instances favicons"
3629 }
3630 ]
3631 },
3632 %{
3633 group: :ex_aws,
3634 key: :s3,
3635 type: :group,
3636 descriptions: "S3 service related settings",
3637 children: [
3638 %{
3639 key: :access_key_id,
3640 type: :string,
3641 description: "S3 access key ID",
3642 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
3643 },
3644 %{
3645 key: :secret_access_key,
3646 type: :string,
3647 description: "Secret access key",
3648 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
3649 },
3650 %{
3651 key: :host,
3652 type: :string,
3653 description: "S3 host",
3654 suggestions: ["s3.eu-central-1.amazonaws.com"]
3655 }
3656 ]
3657 },
3658 %{
3659 group: :pleroma,
3660 key: :frontends,
3661 type: :group,
3662 description: "Installed frontends management",
3663 children: [
3664 %{
3665 key: :primary,
3666 type: :map,
3667 description: "Primary frontend, the one that is served for all pages by default",
3668 children: installed_frontend_options
3669 },
3670 %{
3671 key: :admin,
3672 type: :map,
3673 description: "Admin frontend",
3674 children: installed_frontend_options
3675 },
3676 %{
3677 key: :available,
3678 type: :map,
3679 description:
3680 "A map containing available frontends and parameters for their installation.",
3681 children: [
3682 frontend_options
3683 ]
3684 }
3685 ]
3686 },
3687 %{
3688 group: :pleroma,
3689 key: Pleroma.Web.Preload,
3690 type: :group,
3691 description: "Preload-related settings",
3692 children: [
3693 %{
3694 key: :providers,
3695 type: {:list, :module},
3696 description: "List of preload providers to enable",
3697 suggestions: [
3698 Pleroma.Web.Preload.Providers.Instance,
3699 Pleroma.Web.Preload.Providers.User,
3700 Pleroma.Web.Preload.Providers.Timelines,
3701 Pleroma.Web.Preload.Providers.StatusNet
3702 ]
3703 }
3704 ]
3705 }
3706 ]