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