add bubble timeline (#100)
[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 "List of ActivityPub instances where private (DMs, followers-only) 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",
1446 suggestions: ["#282c37", "mediumpurple"]
1447 },
1448 %{
1449 key: :background_color,
1450 type: :string,
1451 description: "Describe the background color of the app",
1452 suggestions: ["#191b22", "aliceblue"]
1453 }
1454 ]
1455 },
1456 %{
1457 group: :pleroma,
1458 key: :media_proxy,
1459 type: :group,
1460 description: "Media proxy",
1461 children: [
1462 %{
1463 key: :enabled,
1464 type: :boolean,
1465 description: "Enables proxying of remote media via the instance's proxy"
1466 },
1467 %{
1468 key: :base_url,
1469 label: "Base URL",
1470 type: :string,
1471 description:
1472 "The base URL to access a user-uploaded file. Useful when you want to proxy the media files via another host/CDN fronts.",
1473 suggestions: ["https://example.com"]
1474 },
1475 %{
1476 key: :invalidation,
1477 type: :keyword,
1478 descpiption: "",
1479 suggestions: [
1480 enabled: true,
1481 provider: Pleroma.Web.MediaProxy.Invalidation.Script
1482 ],
1483 children: [
1484 %{
1485 key: :enabled,
1486 type: :boolean,
1487 description: "Enables media cache object invalidation."
1488 },
1489 %{
1490 key: :provider,
1491 type: :module,
1492 description: "Module which will be used to purge objects from the cache.",
1493 suggestions: [
1494 Pleroma.Web.MediaProxy.Invalidation.Script,
1495 Pleroma.Web.MediaProxy.Invalidation.Http
1496 ]
1497 }
1498 ]
1499 },
1500 %{
1501 key: :proxy_opts,
1502 label: "Advanced MediaProxy Options",
1503 type: :keyword,
1504 description: "Internal Pleroma.ReverseProxy settings",
1505 suggestions: [
1506 redirect_on_failure: false,
1507 max_body_length: 25 * 1_048_576,
1508 max_read_duration: 30_000
1509 ],
1510 children: [
1511 %{
1512 key: :redirect_on_failure,
1513 type: :boolean,
1514 description: """
1515 Redirects the client to the origin server upon encountering HTTP errors.\n
1516 Note that files larger than Max Body Length will trigger an error. (e.g., Peertube videos)\n\n
1517 **WARNING:** This setting will allow larger files to be accessed, but exposes the\n
1518 IP addresses of your users to the other servers, bypassing the MediaProxy.
1519 """
1520 },
1521 %{
1522 key: :max_body_length,
1523 type: :integer,
1524 description:
1525 "Maximum file size (in bytes) allowed through the Pleroma MediaProxy cache."
1526 },
1527 %{
1528 key: :max_read_duration,
1529 type: :integer,
1530 description: "Timeout (in milliseconds) of GET request to the remote URI."
1531 }
1532 ]
1533 },
1534 %{
1535 key: :whitelist,
1536 type: {:list, :string},
1537 description: "List of hosts with scheme to bypass the MediaProxy",
1538 suggestions: ["http://example.com"]
1539 }
1540 ]
1541 },
1542 %{
1543 group: :pleroma,
1544 key: :media_preview_proxy,
1545 type: :group,
1546 description: "Media preview proxy",
1547 children: [
1548 %{
1549 key: :enabled,
1550 type: :boolean,
1551 description:
1552 "Enables proxying of remote media preview to the instance's proxy. Requires enabled media proxy."
1553 },
1554 %{
1555 key: :thumbnail_max_width,
1556 type: :integer,
1557 description:
1558 "Max width of preview thumbnail for images (video preview always has original dimensions)."
1559 },
1560 %{
1561 key: :thumbnail_max_height,
1562 type: :integer,
1563 description:
1564 "Max height of preview thumbnail for images (video preview always has original dimensions)."
1565 },
1566 %{
1567 key: :image_quality,
1568 type: :integer,
1569 description: "Quality of the output. Ranges from 0 (min quality) to 100 (max quality)."
1570 },
1571 %{
1572 key: :min_content_length,
1573 type: :integer,
1574 description:
1575 "Min content length (in bytes) to perform preview. Media smaller in size will be served without thumbnailing."
1576 }
1577 ]
1578 },
1579 %{
1580 group: :pleroma,
1581 key: Pleroma.Web.MediaProxy.Invalidation.Http,
1582 type: :group,
1583 description: "HTTP invalidate settings",
1584 children: [
1585 %{
1586 key: :method,
1587 type: :atom,
1588 description: "HTTP method of request. Default: :purge"
1589 },
1590 %{
1591 key: :headers,
1592 type: {:keyword, :string},
1593 description: "HTTP headers of request",
1594 suggestions: [{"x-refresh", 1}]
1595 },
1596 %{
1597 key: :options,
1598 type: :keyword,
1599 description: "Request options",
1600 children: [
1601 %{
1602 key: :params,
1603 type: {:map, :string}
1604 }
1605 ]
1606 }
1607 ]
1608 },
1609 %{
1610 group: :pleroma,
1611 key: Pleroma.Web.MediaProxy.Invalidation.Script,
1612 type: :group,
1613 description: "Invalidation script settings",
1614 children: [
1615 %{
1616 key: :script_path,
1617 type: :string,
1618 description: "Path to executable script which will purge cached items.",
1619 suggestions: ["./installation/nginx-cache-purge.sh.example"]
1620 },
1621 %{
1622 key: :url_format,
1623 label: "URL Format",
1624 type: :string,
1625 description:
1626 "Optional URL format preprocessing. Only required for Apache's htcacheclean.",
1627 suggestions: [":htcacheclean"]
1628 }
1629 ]
1630 },
1631 %{
1632 group: :pleroma,
1633 key: :activitypub,
1634 label: "ActivityPub",
1635 type: :group,
1636 description: "ActivityPub-related settings",
1637 children: [
1638 %{
1639 key: :unfollow_blocked,
1640 type: :boolean,
1641 description: "Whether blocks result in people getting unfollowed"
1642 },
1643 %{
1644 key: :outgoing_blocks,
1645 type: :boolean,
1646 description: "Whether to federate blocks to other instances"
1647 },
1648 %{
1649 key: :blockers_visible,
1650 type: :boolean,
1651 description: "Whether a user can see someone who has blocked them"
1652 },
1653 %{
1654 key: :sign_object_fetches,
1655 type: :boolean,
1656 description: "Sign object fetches with HTTP signatures"
1657 },
1658 %{
1659 key: :note_replies_output_limit,
1660 type: :integer,
1661 description:
1662 "The number of Note replies' URIs to be included with outgoing federation (`5` to match Mastodon hardcoded value, `0` to disable the output)"
1663 },
1664 %{
1665 key: :follow_handshake_timeout,
1666 type: :integer,
1667 description: "Following handshake timeout",
1668 suggestions: [500]
1669 },
1670 %{
1671 key: :max_collection_objects,
1672 type: :integer,
1673 description:
1674 "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.",
1675 suggestions: [50]
1676 }
1677 ]
1678 },
1679 %{
1680 group: :pleroma,
1681 key: :http_security,
1682 label: "HTTP security",
1683 type: :group,
1684 description: "HTTP security settings",
1685 children: [
1686 %{
1687 key: :enabled,
1688 type: :boolean,
1689 description: "Whether the managed content security policy is enabled"
1690 },
1691 %{
1692 key: :sts,
1693 label: "STS",
1694 type: :boolean,
1695 description: "Whether to additionally send a Strict-Transport-Security header"
1696 },
1697 %{
1698 key: :sts_max_age,
1699 label: "STS max age",
1700 type: :integer,
1701 description: "The maximum age for the Strict-Transport-Security header if sent",
1702 suggestions: [31_536_000]
1703 },
1704 %{
1705 key: :ct_max_age,
1706 label: "CT max age",
1707 type: :integer,
1708 description: "The maximum age for the Expect-CT header if sent",
1709 suggestions: [2_592_000]
1710 },
1711 %{
1712 key: :referrer_policy,
1713 type: :string,
1714 description: "The referrer policy to use, either \"same-origin\" or \"no-referrer\"",
1715 suggestions: ["same-origin", "no-referrer"]
1716 },
1717 %{
1718 key: :report_uri,
1719 label: "Report URI",
1720 type: :string,
1721 description: "Adds the specified URL to report-uri and report-to group in CSP header",
1722 suggestions: ["https://example.com/report-uri"]
1723 }
1724 ]
1725 },
1726 %{
1727 group: :web_push_encryption,
1728 key: :vapid_details,
1729 label: "Vapid Details",
1730 type: :group,
1731 description:
1732 "Web Push Notifications configuration. You can use the mix task mix web_push.gen.keypair to generate it.",
1733 children: [
1734 %{
1735 key: :subject,
1736 type: :string,
1737 description:
1738 "A mailto link for the administrative contact." <>
1739 " It's best if this email is not a personal email address, but rather a group email to the instance moderation team.",
1740 suggestions: ["mailto:moderators@pleroma.com"]
1741 },
1742 %{
1743 key: :public_key,
1744 type: :string,
1745 description: "VAPID public key",
1746 suggestions: ["Public key"]
1747 },
1748 %{
1749 key: :private_key,
1750 type: :string,
1751 description: "VAPID private key",
1752 suggestions: ["Private key"]
1753 }
1754 ]
1755 },
1756 %{
1757 group: :pleroma,
1758 key: Pleroma.Captcha,
1759 type: :group,
1760 description: "Captcha-related settings",
1761 children: [
1762 %{
1763 key: :enabled,
1764 type: :boolean,
1765 description: "Whether the captcha should be shown on registration"
1766 },
1767 %{
1768 key: :method,
1769 type: :module,
1770 description: "The method/service to use for captcha",
1771 suggestions: [Pleroma.Captcha.Kocaptcha, Pleroma.Captcha.Native]
1772 },
1773 %{
1774 key: :seconds_valid,
1775 type: :integer,
1776 description: "The time in seconds for which the captcha is valid",
1777 suggestions: [60]
1778 }
1779 ]
1780 },
1781 %{
1782 group: :pleroma,
1783 key: Pleroma.Captcha.Kocaptcha,
1784 type: :group,
1785 description:
1786 "Kocaptcha is a very simple captcha service with a single API endpoint, the source code is" <>
1787 " here: https://github.com/koto-bank/kocaptcha. The default endpoint (https://captcha.kotobank.ch) is hosted by the developer.",
1788 children: [
1789 %{
1790 key: :endpoint,
1791 type: :string,
1792 description: "The kocaptcha endpoint to use",
1793 suggestions: ["https://captcha.kotobank.ch"]
1794 }
1795 ]
1796 },
1797 %{
1798 group: :pleroma,
1799 label: "Pleroma Admin Token",
1800 type: :group,
1801 description:
1802 "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)",
1803 children: [
1804 %{
1805 key: :admin_token,
1806 type: :string,
1807 description: "Admin token",
1808 suggestions: [
1809 "Please use a high entropy string or UUID"
1810 ]
1811 }
1812 ]
1813 },
1814 %{
1815 group: :pleroma,
1816 key: Oban,
1817 type: :group,
1818 description:
1819 "[Oban](https://github.com/sorentwo/oban) asynchronous job processor configuration.",
1820 children: [
1821 %{
1822 key: :log,
1823 type: {:dropdown, :atom},
1824 description: "Logs verbose mode",
1825 suggestions: [false, :error, :warn, :info, :debug]
1826 },
1827 %{
1828 key: :queues,
1829 type: {:keyword, :integer},
1830 description:
1831 "Background jobs queues (keys: queues, values: max numbers of concurrent jobs)",
1832 suggestions: [
1833 activity_expiration: 10,
1834 attachments_cleanup: 5,
1835 background: 5,
1836 federator_incoming: 50,
1837 federator_outgoing: 50,
1838 mailer: 10,
1839 scheduled_activities: 10,
1840 transmogrifier: 20,
1841 web_push: 50
1842 ],
1843 children: [
1844 %{
1845 key: :activity_expiration,
1846 type: :integer,
1847 description: "Activity expiration queue",
1848 suggestions: [10]
1849 },
1850 %{
1851 key: :backup,
1852 type: :integer,
1853 description: "Backup queue",
1854 suggestions: [1]
1855 },
1856 %{
1857 key: :attachments_cleanup,
1858 type: :integer,
1859 description: "Attachment deletion queue",
1860 suggestions: [5]
1861 },
1862 %{
1863 key: :background,
1864 type: :integer,
1865 description: "Background queue",
1866 suggestions: [5]
1867 },
1868 %{
1869 key: :federator_incoming,
1870 type: :integer,
1871 description: "Incoming federation queue",
1872 suggestions: [50]
1873 },
1874 %{
1875 key: :federator_outgoing,
1876 type: :integer,
1877 description: "Outgoing federation queue",
1878 suggestions: [50]
1879 },
1880 %{
1881 key: :mailer,
1882 type: :integer,
1883 description: "Email sender queue, see Pleroma.Emails.Mailer",
1884 suggestions: [10]
1885 },
1886 %{
1887 key: :scheduled_activities,
1888 type: :integer,
1889 description: "Scheduled activities queue, see Pleroma.ScheduledActivities",
1890 suggestions: [10]
1891 },
1892 %{
1893 key: :transmogrifier,
1894 type: :integer,
1895 description: "Transmogrifier queue",
1896 suggestions: [20]
1897 },
1898 %{
1899 key: :web_push,
1900 type: :integer,
1901 description: "Web push notifications queue",
1902 suggestions: [50]
1903 }
1904 ]
1905 },
1906 %{
1907 key: :crontab,
1908 type: {:list, :tuple},
1909 description: "Settings for cron background jobs",
1910 suggestions: [
1911 {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker},
1912 {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker}
1913 ]
1914 }
1915 ]
1916 },
1917 %{
1918 group: :pleroma,
1919 key: :workers,
1920 type: :group,
1921 description: "Includes custom worker options not interpretable directly by `Oban`",
1922 children: [
1923 %{
1924 key: :retries,
1925 type: {:keyword, :integer},
1926 description: "Max retry attempts for failed jobs, per `Oban` queue",
1927 suggestions: [
1928 federator_incoming: 5,
1929 federator_outgoing: 5
1930 ]
1931 }
1932 ]
1933 },
1934 %{
1935 group: :pleroma,
1936 key: Pleroma.Web.Metadata,
1937 type: :group,
1938 description: "Metadata-related settings",
1939 children: [
1940 %{
1941 key: :providers,
1942 type: {:list, :module},
1943 description: "List of metadata providers to enable",
1944 suggestions: [
1945 Pleroma.Web.Metadata.Providers.OpenGraph,
1946 Pleroma.Web.Metadata.Providers.TwitterCard,
1947 Pleroma.Web.Metadata.Providers.RelMe,
1948 Pleroma.Web.Metadata.Providers.Feed
1949 ]
1950 },
1951 %{
1952 key: :unfurl_nsfw,
1953 label: "Unfurl NSFW",
1954 type: :boolean,
1955 description: "When enabled NSFW attachments will be shown in previews"
1956 }
1957 ]
1958 },
1959 %{
1960 group: :pleroma,
1961 key: Pleroma.Web.Metadata.Providers.Theme,
1962 type: :group,
1963 description: "Specific provider to hand out themes to instances that scrape index.html",
1964 children: [
1965 %{
1966 key: :theme_color,
1967 type: :string,
1968 description:
1969 "The 'accent color' of the instance, used in places like misskey's instance ticker",
1970 suggestions: ["#593196"]
1971 }
1972 ]
1973 },
1974 %{
1975 group: :pleroma,
1976 key: :rich_media,
1977 type: :group,
1978 description:
1979 "If enabled the instance will parse metadata from attached links to generate link previews",
1980 children: [
1981 %{
1982 key: :enabled,
1983 type: :boolean,
1984 description: "Enables RichMedia parsing of URLs"
1985 },
1986 %{
1987 key: :ignore_hosts,
1988 type: {:list, :string},
1989 description: "List of hosts which will be ignored by the metadata parser",
1990 suggestions: ["accounts.google.com", "xss.website"]
1991 },
1992 %{
1993 key: :ignore_tld,
1994 label: "Ignore TLD",
1995 type: {:list, :string},
1996 description: "List TLDs (top-level domains) which will ignore for parse metadata",
1997 suggestions: ["local", "localdomain", "lan"]
1998 },
1999 %{
2000 key: :parsers,
2001 type: {:list, :module},
2002 description:
2003 "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.",
2004 suggestions: [
2005 Pleroma.Web.RichMedia.Parsers.OEmbed,
2006 Pleroma.Web.RichMedia.Parsers.TwitterCard
2007 ]
2008 },
2009 %{
2010 key: :ttl_setters,
2011 label: "TTL setters",
2012 type: {:list, :module},
2013 description:
2014 "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.",
2015 suggestions: [
2016 Pleroma.Web.RichMedia.Parser.TTL.AwsSignedUrl
2017 ]
2018 },
2019 %{
2020 key: :failure_backoff,
2021 type: :integer,
2022 description:
2023 "Amount of milliseconds after request failure, during which the request will not be retried.",
2024 suggestions: [60_000]
2025 }
2026 ]
2027 },
2028 %{
2029 group: :pleroma,
2030 key: Pleroma.Formatter,
2031 label: "Linkify",
2032 type: :group,
2033 description:
2034 "Configuration for Pleroma's link formatter which parses mentions, hashtags, and URLs.",
2035 children: [
2036 %{
2037 key: :class,
2038 type: [:string, :boolean],
2039 description: "Specify the class to be added to the generated link. Disable to clear.",
2040 suggestions: ["auto-linker", false]
2041 },
2042 %{
2043 key: :rel,
2044 type: [:string, :boolean],
2045 description: "Override the rel attribute. Disable to clear.",
2046 suggestions: ["ugc", "noopener noreferrer", false]
2047 },
2048 %{
2049 key: :new_window,
2050 type: :boolean,
2051 description: "Link URLs will open in a new window/tab."
2052 },
2053 %{
2054 key: :truncate,
2055 type: [:integer, :boolean],
2056 description:
2057 "Set to a number to truncate URLs longer than the number. Truncated URLs will end in `...`",
2058 suggestions: [15, false]
2059 },
2060 %{
2061 key: :strip_prefix,
2062 type: :boolean,
2063 description: "Strip the scheme prefix."
2064 },
2065 %{
2066 key: :extra,
2067 type: :boolean,
2068 description: "Link URLs with rarely used schemes (magnet, ipfs, irc, etc.)"
2069 },
2070 %{
2071 key: :validate_tld,
2072 type: [:atom, :boolean],
2073 description:
2074 "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)",
2075 suggestions: [:no_scheme, true]
2076 }
2077 ]
2078 },
2079 %{
2080 group: :pleroma,
2081 key: Pleroma.ScheduledActivity,
2082 type: :group,
2083 description: "Scheduled activities settings",
2084 children: [
2085 %{
2086 key: :daily_user_limit,
2087 type: :integer,
2088 description:
2089 "The number of scheduled activities a user is allowed to create in a single day. Default: 25.",
2090 suggestions: [25]
2091 },
2092 %{
2093 key: :total_user_limit,
2094 type: :integer,
2095 description:
2096 "The number of scheduled activities a user is allowed to create in total. Default: 300.",
2097 suggestions: [300]
2098 },
2099 %{
2100 key: :enabled,
2101 type: :boolean,
2102 description: "Whether scheduled activities are sent to the job queue to be executed"
2103 }
2104 ]
2105 },
2106 %{
2107 group: :pleroma,
2108 key: Pleroma.Workers.PurgeExpiredActivity,
2109 type: :group,
2110 description: "Expired activities settings",
2111 children: [
2112 %{
2113 key: :enabled,
2114 type: :boolean,
2115 description: "Enables expired activities addition & deletion"
2116 },
2117 %{
2118 key: :min_lifetime,
2119 type: :integer,
2120 description: "Minimum lifetime for ephemeral activity (in seconds)",
2121 suggestions: [600]
2122 }
2123 ]
2124 },
2125 %{
2126 group: :pleroma,
2127 label: "Pleroma Authenticator",
2128 type: :group,
2129 description: "Authenticator",
2130 children: [
2131 %{
2132 key: Pleroma.Web.Auth.Authenticator,
2133 type: :module,
2134 suggestions: [Pleroma.Web.Auth.PleromaAuthenticator, Pleroma.Web.Auth.LDAPAuthenticator]
2135 }
2136 ]
2137 },
2138 %{
2139 group: :pleroma,
2140 key: :auth,
2141 type: :group,
2142 description: "Authentication / authorization settings",
2143 children: [
2144 %{
2145 key: :enforce_oauth_admin_scope_usage,
2146 label: "Enforce OAuth admin scope usage",
2147 type: :boolean,
2148 description:
2149 "OAuth admin scope requirement toggle. " <>
2150 "If enabled, admin actions explicitly demand admin OAuth scope(s) presence in OAuth token " <>
2151 "(client app must support admin scopes). If disabled and token doesn't have admin scope(s), " <>
2152 "`is_admin` user flag grants access to admin-specific actions."
2153 },
2154 %{
2155 key: :auth_template,
2156 type: :string,
2157 description:
2158 "Authentication form template. By default it's `show.html` which corresponds to `lib/pleroma/web/templates/o_auth/o_auth/show.html.ee`.",
2159 suggestions: ["show.html"]
2160 },
2161 %{
2162 key: :oauth_consumer_template,
2163 label: "OAuth consumer template",
2164 type: :string,
2165 description:
2166 "OAuth consumer mode authentication form template. By default it's `consumer.html` which corresponds to" <>
2167 " `lib/pleroma/web/templates/o_auth/o_auth/consumer.html.eex`.",
2168 suggestions: ["consumer.html"]
2169 },
2170 %{
2171 key: :oauth_consumer_strategies,
2172 label: "OAuth consumer strategies",
2173 type: {:list, :string},
2174 description:
2175 "The list of enabled OAuth consumer strategies. By default it's set by OAUTH_CONSUMER_STRATEGIES environment variable." <>
2176 " Each entry in this space-delimited string should be of format \"strategy\" or \"strategy:dependency\"" <>
2177 " (e.g. twitter or keycloak:ueberauth_keycloak_strategy in case dependency is named differently than ueberauth_<strategy>).",
2178 suggestions: ["twitter", "keycloak:ueberauth_keycloak_strategy"]
2179 }
2180 ]
2181 },
2182 %{
2183 group: :pleroma,
2184 key: :email_notifications,
2185 type: :group,
2186 description: "Email notifications settings",
2187 children: [
2188 %{
2189 key: :digest,
2190 type: :map,
2191 description:
2192 "emails of \"what you've missed\" for users who have been inactive for a while",
2193 suggestions: [
2194 %{
2195 active: false,
2196 schedule: "0 0 * * 0",
2197 interval: 7,
2198 inactivity_threshold: 7
2199 }
2200 ],
2201 children: [
2202 %{
2203 key: :active,
2204 label: "Enabled",
2205 type: :boolean,
2206 description: "Globally enable or disable digest emails"
2207 },
2208 %{
2209 key: :schedule,
2210 type: :string,
2211 description:
2212 "When to send digest email, in crontab format. \"0 0 0\" is the default, meaning \"once a week at midnight on Sunday morning\".",
2213 suggestions: ["0 0 * * 0"]
2214 },
2215 %{
2216 key: :interval,
2217 type: :integer,
2218 description: "Minimum interval between digest emails to one user",
2219 suggestions: [7]
2220 },
2221 %{
2222 key: :inactivity_threshold,
2223 type: :integer,
2224 description: "Minimum user inactivity threshold",
2225 suggestions: [7]
2226 }
2227 ]
2228 }
2229 ]
2230 },
2231 %{
2232 group: :pleroma,
2233 key: Pleroma.Emails.UserEmail,
2234 type: :group,
2235 description: "Email template settings",
2236 children: [
2237 %{
2238 key: :logo,
2239 type: {:string, :image},
2240 description: "A path to a custom logo. Set it to `nil` to use the default Pleroma logo.",
2241 suggestions: ["some/path/logo.png"]
2242 },
2243 %{
2244 key: :styling,
2245 type: :map,
2246 description: "A map with color settings for email templates.",
2247 suggestions: [
2248 %{
2249 link_color: "#d8a070",
2250 background_color: "#2C3645",
2251 content_background_color: "#1B2635",
2252 header_color: "#d8a070",
2253 text_color: "#b9b9ba",
2254 text_muted_color: "#b9b9ba"
2255 }
2256 ],
2257 children: [
2258 %{
2259 key: :link_color,
2260 type: :string,
2261 suggestions: ["#d8a070"]
2262 },
2263 %{
2264 key: :background_color,
2265 type: :string,
2266 suggestions: ["#2C3645"]
2267 },
2268 %{
2269 key: :content_background_color,
2270 type: :string,
2271 suggestions: ["#1B2635"]
2272 },
2273 %{
2274 key: :header_color,
2275 type: :string,
2276 suggestions: ["#d8a070"]
2277 },
2278 %{
2279 key: :text_color,
2280 type: :string,
2281 suggestions: ["#b9b9ba"]
2282 },
2283 %{
2284 key: :text_muted_color,
2285 type: :string,
2286 suggestions: ["#b9b9ba"]
2287 }
2288 ]
2289 }
2290 ]
2291 },
2292 %{
2293 group: :pleroma,
2294 key: Pleroma.Emails.NewUsersDigestEmail,
2295 type: :group,
2296 description: "New users admin email digest",
2297 children: [
2298 %{
2299 key: :enabled,
2300 type: :boolean,
2301 description: "Enables new users admin digest email when `true`"
2302 }
2303 ]
2304 },
2305 %{
2306 group: :pleroma,
2307 key: :oauth2,
2308 label: "OAuth2",
2309 type: :group,
2310 description: "Configure OAuth 2 provider capabilities",
2311 children: [
2312 %{
2313 key: :token_expires_in,
2314 type: :integer,
2315 description: "The lifetime in seconds of the access token",
2316 suggestions: [2_592_000]
2317 },
2318 %{
2319 key: :issue_new_refresh_token,
2320 type: :boolean,
2321 description:
2322 "Keeps old refresh token or generate new refresh token when to obtain an access token"
2323 },
2324 %{
2325 key: :clean_expired_tokens,
2326 type: :boolean,
2327 description: "Enable a background job to clean expired OAuth tokens. Default: disabled."
2328 }
2329 ]
2330 },
2331 %{
2332 group: :pleroma,
2333 key: :emoji,
2334 type: :group,
2335 children: [
2336 %{
2337 key: :shortcode_globs,
2338 type: {:list, :string},
2339 description: "Location of custom emoji files. * can be used as a wildcard.",
2340 suggestions: ["/emoji/custom/**/*.png"]
2341 },
2342 %{
2343 key: :pack_extensions,
2344 type: {:list, :string},
2345 description:
2346 "A list of file extensions for emojis, when no emoji.txt for a pack is present",
2347 suggestions: [".png", ".gif"]
2348 },
2349 %{
2350 key: :groups,
2351 type: {:keyword, {:list, :string}},
2352 description:
2353 "Emojis are ordered in groups (tags). This is an array of key-value pairs where the key is the group name" <>
2354 " and the value is the location or array of locations. * can be used as a wildcard.",
2355 suggestions: [
2356 Custom: ["/emoji/*.png", "/emoji/**/*.png"]
2357 ]
2358 },
2359 %{
2360 key: :default_manifest,
2361 type: :string,
2362 description:
2363 "Location of the JSON-manifest. This manifest contains information about the emoji-packs you can download." <>
2364 " Currently only one manifest can be added (no arrays).",
2365 suggestions: ["https://git.pleroma.social/pleroma/emoji-index/raw/master/index.json"]
2366 },
2367 %{
2368 key: :shared_pack_cache_seconds_per_file,
2369 label: "Shared pack cache s/file",
2370 type: :integer,
2371 descpiption:
2372 "When an emoji pack is shared, the archive is created and cached in memory" <>
2373 " for this amount of seconds multiplied by the number of files.",
2374 suggestions: [60]
2375 }
2376 ]
2377 },
2378 %{
2379 group: :pleroma,
2380 key: :rate_limit,
2381 type: :group,
2382 description:
2383 "Rate limit settings. This is an advanced feature enabled only for :authentication by default.",
2384 children: [
2385 %{
2386 key: :search,
2387 type: [:tuple, {:list, :tuple}],
2388 description: "For the search requests (account & status search etc.)",
2389 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2390 },
2391 %{
2392 key: :timeline,
2393 type: [:tuple, {:list, :tuple}],
2394 description: "For requests to timelines (each timeline has it's own limiter)",
2395 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2396 },
2397 %{
2398 key: :app_account_creation,
2399 type: [:tuple, {:list, :tuple}],
2400 description: "For registering user accounts from the same IP address",
2401 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2402 },
2403 %{
2404 key: :relations_actions,
2405 type: [:tuple, {:list, :tuple}],
2406 description: "For actions on relationships with all users (follow, unfollow)",
2407 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2408 },
2409 %{
2410 key: :relation_id_action,
2411 label: "Relation ID action",
2412 type: [:tuple, {:list, :tuple}],
2413 description: "For actions on relation with a specific user (follow, unfollow)",
2414 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2415 },
2416 %{
2417 key: :statuses_actions,
2418 type: [:tuple, {:list, :tuple}],
2419 description:
2420 "For create / delete / fav / unfav / reblog / unreblog actions on any statuses",
2421 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2422 },
2423 %{
2424 key: :status_id_action,
2425 label: "Status ID action",
2426 type: [:tuple, {:list, :tuple}],
2427 description:
2428 "For fav / unfav or reblog / unreblog actions on the same status by the same user",
2429 suggestions: [{1000, 10}, [{10_000, 10}, {10_000, 50}]]
2430 },
2431 %{
2432 key: :authentication,
2433 type: [:tuple, {:list, :tuple}],
2434 description: "For authentication create / password check / user existence check requests",
2435 suggestions: [{60_000, 15}]
2436 }
2437 ]
2438 },
2439 %{
2440 group: :mime,
2441 label: "Mime Types",
2442 type: :group,
2443 description: "Mime Types settings",
2444 children: [
2445 %{
2446 key: :types,
2447 type: :map,
2448 suggestions: [
2449 %{
2450 "application/xml" => ["xml"],
2451 "application/xrd+xml" => ["xrd+xml"],
2452 "application/jrd+json" => ["jrd+json"],
2453 "application/activity+json" => ["activity+json"],
2454 "application/ld+json" => ["activity+json"]
2455 }
2456 ],
2457 children: [
2458 %{
2459 key: "application/xml",
2460 type: {:list, :string},
2461 suggestions: ["xml"]
2462 },
2463 %{
2464 key: "application/xrd+xml",
2465 type: {:list, :string},
2466 suggestions: ["xrd+xml"]
2467 },
2468 %{
2469 key: "application/jrd+json",
2470 type: {:list, :string},
2471 suggestions: ["jrd+json"]
2472 },
2473 %{
2474 key: "application/activity+json",
2475 type: {:list, :string},
2476 suggestions: ["activity+json"]
2477 },
2478 %{
2479 key: "application/ld+json",
2480 type: {:list, :string},
2481 suggestions: ["activity+json"]
2482 }
2483 ]
2484 }
2485 ]
2486 },
2487 %{
2488 group: :pleroma,
2489 key: :http,
2490 label: "HTTP",
2491 type: :group,
2492 description: "HTTP settings",
2493 children: [
2494 %{
2495 key: :proxy_url,
2496 label: "Proxy URL",
2497 type: [:string, :tuple],
2498 description: "Proxy URL",
2499 suggestions: ["localhost:9020", {:socks5, :localhost, 3090}]
2500 },
2501 %{
2502 key: :user_agent,
2503 type: [:string, :atom],
2504 description:
2505 "What user agent to use. Must be a string or an atom `:default`. Default value is `:default`.",
2506 suggestions: ["Pleroma", :default]
2507 },
2508 %{
2509 key: :adapter,
2510 type: :keyword,
2511 description: "Adapter specific options",
2512 suggestions: [],
2513 children: [
2514 %{
2515 key: :ssl_options,
2516 type: :keyword,
2517 label: "SSL Options",
2518 description: "SSL options for HTTP adapter",
2519 children: [
2520 %{
2521 key: :versions,
2522 type: {:list, :atom},
2523 description: "List of TLS version to use",
2524 suggestions: [:tlsv1, ":tlsv1.1", ":tlsv1.2"]
2525 }
2526 ]
2527 }
2528 ]
2529 }
2530 ]
2531 },
2532 %{
2533 group: :pleroma,
2534 key: :markup,
2535 label: "Markup Settings",
2536 type: :group,
2537 children: [
2538 %{
2539 key: :allow_inline_images,
2540 type: :boolean
2541 },
2542 %{
2543 key: :allow_headings,
2544 type: :boolean
2545 },
2546 %{
2547 key: :allow_tables,
2548 type: :boolean
2549 },
2550 %{
2551 key: :allow_fonts,
2552 type: :boolean
2553 },
2554 %{
2555 key: :scrub_policy,
2556 type: {:list, :module},
2557 description:
2558 "Module names are shortened (removed leading `Pleroma.HTML.` part), but on adding custom module you need to use full name.",
2559 suggestions: [Pleroma.HTML.Transform.MediaProxy, Pleroma.HTML.Scrubber.Default]
2560 }
2561 ]
2562 },
2563 %{
2564 group: :pleroma,
2565 key: :user,
2566 type: :group,
2567 children: [
2568 %{
2569 key: :deny_follow_blocked,
2570 type: :boolean
2571 }
2572 ]
2573 },
2574 %{
2575 group: :pleroma,
2576 key: Pleroma.User,
2577 type: :group,
2578 children: [
2579 %{
2580 key: :restricted_nicknames,
2581 type: {:list, :string},
2582 description: "List of nicknames users may not register with.",
2583 suggestions: [
2584 ".well-known",
2585 "~",
2586 "about",
2587 "activities",
2588 "api",
2589 "auth",
2590 "check_password",
2591 "dev",
2592 "friend-requests",
2593 "inbox",
2594 "internal",
2595 "main",
2596 "media",
2597 "nodeinfo",
2598 "notice",
2599 "oauth",
2600 "objects",
2601 "ostatus_subscribe",
2602 "pleroma",
2603 "proxy",
2604 "push",
2605 "registration",
2606 "relay",
2607 "settings",
2608 "status",
2609 "tag",
2610 "user-search",
2611 "user_exists",
2612 "users",
2613 "web"
2614 ]
2615 },
2616 %{
2617 key: :email_blacklist,
2618 type: {:list, :string},
2619 description: "List of email domains users may not register with.",
2620 suggestions: ["mailinator.com", "maildrop.cc"]
2621 }
2622 ]
2623 },
2624 %{
2625 group: :cors_plug,
2626 label: "CORS plug config",
2627 type: :group,
2628 children: [
2629 %{
2630 key: :max_age,
2631 type: :integer,
2632 suggestions: [86_400]
2633 },
2634 %{
2635 key: :methods,
2636 type: {:list, :string},
2637 suggestions: ["POST", "PUT", "DELETE", "GET", "PATCH", "OPTIONS"]
2638 },
2639 %{
2640 key: :expose,
2641 type: {:list, :string},
2642 suggestions: [
2643 "Link",
2644 "X-RateLimit-Reset",
2645 "X-RateLimit-Limit",
2646 "X-RateLimit-Remaining",
2647 "X-Request-Id",
2648 "Idempotency-Key"
2649 ]
2650 },
2651 %{
2652 key: :credentials,
2653 type: :boolean
2654 },
2655 %{
2656 key: :headers,
2657 type: {:list, :string},
2658 suggestions: ["Authorization", "Content-Type", "Idempotency-Key"]
2659 }
2660 ]
2661 },
2662 %{
2663 group: :pleroma,
2664 key: Pleroma.Web.Plugs.RemoteIp,
2665 type: :group,
2666 description: """
2667 `Pleroma.Web.Plugs.RemoteIp` is a shim to call [`RemoteIp`](https://git.pleroma.social/pleroma/remote_ip) but with runtime configuration.
2668 **If your instance is not behind at least one reverse proxy, you should not enable this plug.**
2669 """,
2670 children: [
2671 %{
2672 key: :enabled,
2673 type: :boolean,
2674 description: "Enable/disable the plug. Default: disabled."
2675 },
2676 %{
2677 key: :headers,
2678 type: {:list, :string},
2679 description: """
2680 A list of strings naming the HTTP headers to use when deriving the true client IP. Default: `["x-forwarded-for"]`.
2681 """
2682 },
2683 %{
2684 key: :proxies,
2685 type: {:list, :string},
2686 description:
2687 "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."
2688 },
2689 %{
2690 key: :reserved,
2691 type: {:list, :string},
2692 description: """
2693 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"]`
2694 """
2695 }
2696 ]
2697 },
2698 %{
2699 group: :pleroma,
2700 key: :web_cache_ttl,
2701 label: "Web cache TTL",
2702 type: :group,
2703 description:
2704 "The expiration time for the web responses cache. Values should be in milliseconds or `nil` to disable expiration.",
2705 children: [
2706 %{
2707 key: :activity_pub,
2708 type: :integer,
2709 description:
2710 "Activity pub routes (except question activities). Default: `nil` (no expiration).",
2711 suggestions: [nil]
2712 },
2713 %{
2714 key: :activity_pub_question,
2715 type: :integer,
2716 description: "Activity pub routes (question activities). Default: `30_000` (30 seconds).",
2717 suggestions: [30_000]
2718 }
2719 ]
2720 },
2721 %{
2722 group: :pleroma,
2723 key: :static_fe,
2724 label: "Static FE",
2725 type: :group,
2726 description:
2727 "Render profiles and posts using server-generated HTML that is viewable without using JavaScript",
2728 children: [
2729 %{
2730 key: :enabled,
2731 type: :boolean,
2732 description: "Enables the rendering of static HTML. Default: disabled."
2733 }
2734 ]
2735 },
2736 %{
2737 group: :pleroma,
2738 key: :feed,
2739 type: :group,
2740 description: "Configure feed rendering",
2741 children: [
2742 %{
2743 key: :post_title,
2744 type: :map,
2745 description: "Configure title rendering",
2746 children: [
2747 %{
2748 key: :max_length,
2749 type: :integer,
2750 description: "Maximum number of characters before truncating title",
2751 suggestions: [100]
2752 },
2753 %{
2754 key: :omission,
2755 type: :string,
2756 description: "Replacement which will be used after truncating string",
2757 suggestions: ["..."]
2758 }
2759 ]
2760 }
2761 ]
2762 },
2763 %{
2764 group: :pleroma,
2765 key: :mrf_follow_bot,
2766 tab: :mrf,
2767 related_policy: "Pleroma.Web.ActivityPub.MRF.FollowBotPolicy",
2768 label: "MRF FollowBot Policy",
2769 type: :group,
2770 description: "Automatically follows newly discovered accounts.",
2771 children: [
2772 %{
2773 key: :follower_nickname,
2774 type: :string,
2775 description: "The name of the bot account to use for following newly discovered users.",
2776 suggestions: ["followbot"]
2777 }
2778 ]
2779 },
2780 %{
2781 group: :pleroma,
2782 key: :modules,
2783 type: :group,
2784 description: "Custom Runtime Modules",
2785 children: [
2786 %{
2787 key: :runtime_dir,
2788 type: :string,
2789 description: "A path to custom Elixir modules (such as MRF policies)."
2790 }
2791 ]
2792 },
2793 %{
2794 group: :pleroma,
2795 key: :streamer,
2796 type: :group,
2797 description: "Settings for notifications streamer",
2798 children: [
2799 %{
2800 key: :workers,
2801 type: :integer,
2802 description: "Number of workers to send notifications",
2803 suggestions: [3]
2804 },
2805 %{
2806 key: :overflow_workers,
2807 type: :integer,
2808 description: "Maximum number of workers created if pool is empty",
2809 suggestions: [2]
2810 }
2811 ]
2812 },
2813 %{
2814 group: :pleroma,
2815 key: :restrict_unauthenticated,
2816 label: "Restrict Unauthenticated",
2817 type: :group,
2818 description:
2819 "Disallow viewing timelines, user profiles and statuses for unauthenticated users.",
2820 children: [
2821 %{
2822 key: :timelines,
2823 type: :map,
2824 description: "Settings for public and federated timelines.",
2825 children: [
2826 %{
2827 key: :local,
2828 type: :boolean,
2829 description: "Disallow view public timeline."
2830 },
2831 %{
2832 key: :federated,
2833 type: :boolean,
2834 description: "Disallow view federated timeline."
2835 }
2836 ]
2837 },
2838 %{
2839 key: :profiles,
2840 type: :map,
2841 description: "Settings for user profiles.",
2842 children: [
2843 %{
2844 key: :local,
2845 type: :boolean,
2846 description: "Disallow view local user profiles."
2847 },
2848 %{
2849 key: :remote,
2850 type: :boolean,
2851 description: "Disallow view remote user profiles."
2852 }
2853 ]
2854 },
2855 %{
2856 key: :activities,
2857 type: :map,
2858 description: "Settings for statuses.",
2859 children: [
2860 %{
2861 key: :local,
2862 type: :boolean,
2863 description: "Disallow view local statuses."
2864 },
2865 %{
2866 key: :remote,
2867 type: :boolean,
2868 description: "Disallow view remote statuses."
2869 }
2870 ]
2871 }
2872 ]
2873 },
2874 %{
2875 group: :pleroma,
2876 key: Pleroma.Web.ApiSpec.CastAndValidate,
2877 type: :group,
2878 children: [
2879 %{
2880 key: :strict,
2881 type: :boolean,
2882 description:
2883 "Enables strict input validation (useful in development, not recommended in production)"
2884 }
2885 ]
2886 },
2887 %{
2888 group: :pleroma,
2889 key: :instances_favicons,
2890 type: :group,
2891 description: "Control favicons for instances",
2892 children: [
2893 %{
2894 key: :enabled,
2895 type: :boolean,
2896 description: "Allow/disallow displaying and getting instances favicons"
2897 }
2898 ]
2899 },
2900 %{
2901 group: :ex_aws,
2902 key: :s3,
2903 type: :group,
2904 descriptions: "S3 service related settings",
2905 children: [
2906 %{
2907 key: :access_key_id,
2908 type: :string,
2909 description: "S3 access key ID",
2910 suggestions: ["AKIAQ8UKHTGIYN7DMWWJ"]
2911 },
2912 %{
2913 key: :secret_access_key,
2914 type: :string,
2915 description: "Secret access key",
2916 suggestions: ["JFGt+fgH1UQ7vLUQjpW+WvjTdV/UNzVxcwn7DkaeFKtBS5LvoXvIiME4NQBsT6ZZ"]
2917 },
2918 %{
2919 key: :host,
2920 type: :string,
2921 description: "S3 host",
2922 suggestions: ["s3.eu-central-1.amazonaws.com"]
2923 },
2924 %{
2925 key: :region,
2926 type: :string,
2927 description: "S3 region (for AWS)",
2928 suggestions: ["us-east-1"]
2929 }
2930 ]
2931 },
2932 %{
2933 group: :pleroma,
2934 key: :frontends,
2935 type: :group,
2936 description: "Installed frontends management",
2937 children: [
2938 %{
2939 key: :primary,
2940 type: :map,
2941 description: "Primary frontend, the one that is served for all pages by default",
2942 children: installed_frontend_options
2943 },
2944 %{
2945 key: :admin,
2946 type: :map,
2947 description: "Admin frontend",
2948 children: installed_frontend_options
2949 },
2950 %{
2951 key: :mastodon,
2952 type: :map,
2953 description: "Mastodon frontend",
2954 children: installed_frontend_options
2955 },
2956 %{
2957 key: :swagger,
2958 type: :map,
2959 description: "Swagger API reference frontend",
2960 children:
2961 installed_frontend_options ++
2962 [
2963 %{
2964 key: "enabled",
2965 label: "Enabled",
2966 type: :boolean,
2967 description: "Whether to have this enabled at all"
2968 }
2969 ]
2970 },
2971 %{
2972 key: :available,
2973 type: :map,
2974 description:
2975 "A map containing available frontends and parameters for their installation.",
2976 children: frontend_options
2977 }
2978 ]
2979 },
2980 %{
2981 group: :pleroma,
2982 key: Pleroma.Web.Preload,
2983 type: :group,
2984 description: "Preload-related settings",
2985 children: [
2986 %{
2987 key: :providers,
2988 type: {:list, :module},
2989 description: "List of preload providers to enable",
2990 suggestions: [
2991 Pleroma.Web.Preload.Providers.Instance,
2992 Pleroma.Web.Preload.Providers.User,
2993 Pleroma.Web.Preload.Providers.Timelines,
2994 Pleroma.Web.Preload.Providers.StatusNet
2995 ]
2996 }
2997 ]
2998 },
2999 %{
3000 group: :pleroma,
3001 key: :majic_pool,
3002 type: :group,
3003 description: "Majic/libmagic configuration",
3004 children: [
3005 %{
3006 key: :size,
3007 type: :integer,
3008 description: "Number of majic workers to start.",
3009 suggestions: [2]
3010 }
3011 ]
3012 },
3013 %{
3014 group: :pleroma,
3015 key: Pleroma.User.Backup,
3016 type: :group,
3017 description: "Account Backup",
3018 children: [
3019 %{
3020 key: :purge_after_days,
3021 type: :integer,
3022 description: "Remove backup achives after N days",
3023 suggestions: [30]
3024 },
3025 %{
3026 key: :limit_days,
3027 type: :integer,
3028 description: "Limit user to export not more often than once per N days",
3029 suggestions: [7]
3030 }
3031 ]
3032 },
3033 %{
3034 group: :pleroma,
3035 key: ConcurrentLimiter,
3036 type: :group,
3037 description: "Limits configuration for background tasks.",
3038 children: [
3039 %{
3040 key: Pleroma.Web.RichMedia.Helpers,
3041 type: :keyword,
3042 description: "Concurrent limits configuration for getting RichMedia for activities.",
3043 suggestions: [max_running: 5, max_waiting: 5],
3044 children: [
3045 %{
3046 key: :max_running,
3047 type: :integer,
3048 description: "Max running concurrently jobs.",
3049 suggestion: [5]
3050 },
3051 %{
3052 key: :max_waiting,
3053 type: :integer,
3054 description: "Max waiting jobs.",
3055 suggestion: [5]
3056 }
3057 ]
3058 },
3059 %{
3060 key: Pleroma.Web.ActivityPub.MRF.MediaProxyWarmingPolicy,
3061 type: :keyword,
3062 description: "Concurrent limits configuration for MediaProxyWarmingPolicy.",
3063 suggestions: [max_running: 5, max_waiting: 5],
3064 children: [
3065 %{
3066 key: :max_running,
3067 type: :integer,
3068 description: "Max running concurrently jobs.",
3069 suggestion: [5]
3070 },
3071 %{
3072 key: :max_waiting,
3073 type: :integer,
3074 description: "Max waiting jobs.",
3075 suggestion: [5]
3076 }
3077 ]
3078 }
3079 ]
3080 },
3081 %{
3082 group: :pleroma,
3083 key: Pleroma.Search,
3084 type: :group,
3085 description: "General search settings.",
3086 children: [
3087 %{
3088 key: :module,
3089 type: :keyword,
3090 description: "Selected search module.",
3091 suggestion: [Pleroma.Search.DatabaseSearch, Pleroma.Search.Meilisearch]
3092 }
3093 ]
3094 },
3095 %{
3096 group: :pleroma,
3097 key: Pleroma.Search.Meilisearch,
3098 type: :group,
3099 description: "Meilisearch settings.",
3100 children: [
3101 %{
3102 key: :url,
3103 type: :string,
3104 description: "Meilisearch URL.",
3105 suggestion: ["http://127.0.0.1:7700/"]
3106 },
3107 %{
3108 key: :private_key,
3109 type: :string,
3110 description:
3111 "Private key for meilisearch authentication, or `nil` to disable private key authentication.",
3112 suggestion: [nil]
3113 },
3114 %{
3115 key: :initial_indexing_chunk_size,
3116 type: :int,
3117 description:
3118 "Amount of posts in a batch when running the initial indexing operation. Should probably not be more than 100000" <>
3119 " since there's a limit on maximum insert size",
3120 suggestion: [100_000]
3121 }
3122 ]
3123 },
3124 %{
3125 group: :pleroma,
3126 key: Pleroma.Search.Elasticsearch.Cluster,
3127 type: :group,
3128 description: "Elasticsearch settings.",
3129 children: [
3130 %{
3131 key: :url,
3132 type: :string,
3133 description: "Elasticsearch URL.",
3134 suggestion: ["http://127.0.0.1:9200/"]
3135 },
3136 %{
3137 key: :username,
3138 type: :string,
3139 description: "Username to connect to ES. Set to nil if your cluster is unauthenticated.",
3140 suggestion: ["elastic"]
3141 },
3142 %{
3143 key: :password,
3144 type: :string,
3145 description: "Password to connect to ES. Set to nil if your cluster is unauthenticated.",
3146 suggestion: ["changeme"]
3147 },
3148 %{
3149 key: :api,
3150 type: :module,
3151 description:
3152 "The API module used by Elasticsearch. Should always be Elasticsearch.API.HTTP",
3153 suggestion: [Elasticsearch.API.HTTP]
3154 },
3155 %{
3156 key: :json_library,
3157 type: :module,
3158 description:
3159 "The JSON module used to encode/decode when communicating with Elasticsearch",
3160 suggestion: [Jason]
3161 },
3162 %{
3163 key: :indexes,
3164 type: :map,
3165 description: "The indices to set up in Elasticsearch",
3166 children: [
3167 %{
3168 key: :activities,
3169 type: :map,
3170 description: "Config for the index to use for activities",
3171 children: [
3172 %{
3173 key: :settings,
3174 type: :string,
3175 description:
3176 "Path to the file containing index settings for the activities index. Should contain a mapping.",
3177 suggestion: ["priv/es-mappings/activity.json"]
3178 },
3179 %{
3180 key: :store,
3181 type: :module,
3182 description: "The internal store module",
3183 suggestion: [Pleroma.Search.Elasticsearch.Store]
3184 },
3185 %{
3186 key: :sources,
3187 type: {:list, :module},
3188 description: "The internal types to use for this index",
3189 suggestion: [[Pleroma.Activity]]
3190 },
3191 %{
3192 key: :bulk_page_size,
3193 type: :int,
3194 description: "Size for bulk put requests, mostly used on building the index",
3195 suggestion: [5000]
3196 },
3197 %{
3198 key: :bulk_wait_interval,
3199 type: :int,
3200 description: "Time to wait between bulk put requests (in ms)",
3201 suggestion: [15_000]
3202 }
3203 ]
3204 }
3205 ]
3206 }
3207 ]
3208 }
3209 ]