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