git.squeep.com Git - akkoma/blob - config/description.exs

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