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