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