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