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