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