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