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