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