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