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