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