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