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