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

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