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

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