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