projects / akkoma / blob
? search:


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